Module org.jline.prompt

Package org.jline.prompt.impl

Class DefaultConfirmResult

java.lang.Object

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

org.jline.prompt.impl.DefaultConfirmResult

All Implemented Interfaces:

ConfirmResult, PromptResult<ConfirmPrompt>

public class DefaultConfirmResult
extends AbstractPromptResult<ConfirmPrompt>
implements ConfirmResult

Implementation of ConfirmResult.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jline.prompt.ConfirmResult

ConfirmResult.ConfirmationValue

Constructor Summary

Constructors

Constructor	Description
DefaultConfirmResult(ConfirmResult.ConfirmationValue confirmed, ConfirmPrompt prompt)	Create a new DefaultConfirmResult with the given confirmation value and item.

Method Summary

Modifier and Type	Method	Description
ConfirmResult.ConfirmationValue	getConfirmed()	Get the confirmation value.
String	getDisplayResult()	Get a human-readable display representation of the result.
protected String	getRawResult()	Get the raw (unfiltered) result value.
boolean	isConfirmed()	Check if the user confirmed (answered YES).
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

DefaultConfirmResult

public DefaultConfirmResult(ConfirmResult.ConfirmationValue confirmed,
 ConfirmPrompt prompt)

Create a new DefaultConfirmResult with the given confirmation value and item.

Parameters:

confirmed - the confirmation value

item - the associated PromptItem, or null if none

Method Details

getConfirmed

public ConfirmResult.ConfirmationValue getConfirmed()

Description copied from interface: ConfirmResult

Get the confirmation value.

Specified by:

getConfirmed in interface ConfirmResult

Returns:

the confirmation value

isConfirmed

public boolean isConfirmed()

Description copied from interface: ConfirmResult

Check if the user confirmed (answered YES).

Specified by:

isConfirmed in interface ConfirmResult

Returns:

true if the user confirmed, false otherwise

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<ConfirmPrompt>

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<ConfirmPrompt>

Returns:

a display-friendly representation of the result, never null

toString

public String toString()

Overrides:

toString in class Object