Module org.jline.prompt

Package org.jline.prompt.impl

Class DefaultToggleResult

java.lang.Object

org.jline.prompt.impl.AbstractPromptResult<TogglePrompt>

org.jline.prompt.impl.DefaultToggleResult

All Implemented Interfaces:

PromptResult<TogglePrompt>, ToggleResult

public class DefaultToggleResult
extends AbstractPromptResult<TogglePrompt>
implements ToggleResult

Implementation of ToggleResult.

Constructor Summary

Constructors

Constructor	Description
DefaultToggleResult(boolean active, TogglePrompt prompt)

Method Summary

Modifier and Type	Method	Description
String	getDisplayResult()	Get a human-readable display representation of the result.
protected String	getRawResult()	Get the raw (unfiltered) result value.
boolean	isActive()	Get the selected value.
String	toString()

Methods inherited from class org.jline.prompt.impl.AbstractPromptResult

applyFilter, getPrompt, getResult

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jline.prompt.PromptResult

getPrompt, getResult

Constructor Details

DefaultToggleResult

public DefaultToggleResult(boolean active,
 TogglePrompt prompt)

Method Details

isActive

public boolean isActive()

Description copied from interface: ToggleResult

Get the selected value.

Specified by:

isActive in interface ToggleResult

Returns:

true if active state was selected, false for inactive

getRawResult

protected String getRawResult()

Description copied from class: AbstractPromptResult

Get the raw (unfiltered) result value. Subclasses must implement this instead of AbstractPromptResult.getResult().

Specified by:

getRawResult in class AbstractPromptResult<TogglePrompt>

Returns:

the raw result value

getDisplayResult

public String getDisplayResult()

Description copied from interface: PromptResult

Get a human-readable display representation of the result.

This method returns a formatted version of the result that is suitable for display to users. It may differ from PromptResult.getResult() by providing more descriptive text or better formatting.

The default implementation returns the same value as PromptResult.getResult(). Specific result types may override this to provide more user-friendly formatting.

Specified by:

getDisplayResult in interface PromptResult<TogglePrompt>

Returns:

a display-friendly representation of the result, never null

toString

public String toString()

Overrides:

toString in class Object