Module org.jline.prompt

Package org.jline.prompt.impl

Class DefaultEditorResult

java.lang.Object

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

org.jline.prompt.impl.DefaultEditorResult

All Implemented Interfaces:

EditorResult, PromptResult<EditorPrompt>

public class DefaultEditorResult
extends AbstractPromptResult<EditorPrompt>
implements EditorResult

Implementation of EditorResult.

Constructor Summary

Constructors

Constructor	Description
DefaultEditorResult(String text, EditorPrompt prompt)	Create a new DefaultEditorResult with the given text.

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.
String	getText()	Get the edited text content.
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

DefaultEditorResult

public DefaultEditorResult(String text,
 EditorPrompt prompt)

Create a new DefaultEditorResult with the given text.

Parameters:

text - the edited text content

prompt - the associated EditorPrompt

Method Details

getText

public String getText()

Description copied from interface: EditorResult

Get the edited text content.

Specified by:

getText in interface EditorResult

Returns:

the edited text

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

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

Returns:

a display-friendly representation of the result, never null

toString

public String toString()

Overrides:

toString in class Object