org.enginehub.piston.suggestion

Class Suggestion

java.lang.Object

org.enginehub.piston.suggestion.Suggestion

public abstract class Suggestion
extends java.lang.Object

Represents a suggestion.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Suggestion.Builder

Method Summary

Modifier and Type	Method and Description
static Suggestion.Builder	builder()
abstract int	getReplacedArgument() The argument index to replace in the original input.
abstract java.lang.String	getSuggestion() The suggestion value, to be inserted instead of the argument at index replacedArgument.
abstract Suggestion.Builder	toBuilder() Convert this suggestion back to a builder.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static Suggestion.Builder builder()

getSuggestion

public abstract java.lang.String getSuggestion()

The suggestion value, to be inserted instead of the argument at index replacedArgument.

Returns:

the suggestion value

getReplacedArgument

public abstract int getReplacedArgument()

The argument index to replace in the original input.

toBuilder

public abstract Suggestion.Builder toBuilder()

Convert this suggestion back to a builder.