Module org.jline.prompt

Package org.jline.prompt.impl

Class DefaultKeyPressResult

java.lang.Object

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

org.jline.prompt.impl.DefaultKeyPressResult

All Implemented Interfaces:

KeyPressResult, PromptResult<KeyPressPrompt>

public class DefaultKeyPressResult
extends AbstractPromptResult<KeyPressPrompt>
implements KeyPressResult

Implementation of KeyPressResult.

Constructor Summary

Constructors

Constructor	Description
DefaultKeyPressResult(String key, KeyPressPrompt prompt)

Method Summary

Modifier and Type	Method	Description
String	getKey()	Get the key that was pressed.
protected String	getRawResult()	Get the raw (unfiltered) result 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

getDisplayResult, getPrompt, getResult

Constructor Details

DefaultKeyPressResult

public DefaultKeyPressResult(String key,
 KeyPressPrompt prompt)

Method Details

getKey

public String getKey()

Description copied from interface: KeyPressResult

Get the key that was pressed.

Specified by:

getKey in interface KeyPressResult

Returns:

the pressed key as a string

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

Returns:

the raw result value

toString

public String toString()

Overrides:

toString in class Object