org.raml.yagi.framework.suggester

Interface Suggestion

All Superinterfaces:

Comparable<Suggestion>

All Known Implementing Classes:

DefaultSuggestion

public interface Suggestion
extends Comparable<Suggestion>

Method Summary

Modifier and Type	Method and Description
String	getDescription()
String	getLabel()
String	getPrefix()
String	getValue()
Suggestion	withDescription(String description) Creates a new Suggestion based on this suggestion but changing the description with the specified
Suggestion	withPrefix(String prefix) Creates a new Suggestion based on this but changing the prefix
Suggestion	withValue(String value) Creates a new Suggestion based on this suggestion but changing the value with the specified

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getLabel

String getLabel()

Returns:

the label displayed as the suggestion

getDescription

String getDescription()

Returns:

short description of the suggestion

getValue

String getValue()

Returns:

actual value added by the editor

getPrefix

String getPrefix()

Returns:

the prefix that must be append to the value when inserting into de document

withDescription

Suggestion withDescription(String description)

Creates a new Suggestion based on this suggestion but changing the description with the specified

Parameters:

description - The new description

Returns:

A new suggestion with the new description.

withValue

Suggestion withValue(String value)

Creates a new Suggestion based on this suggestion but changing the value with the specified

Parameters:

value - The new value

Returns:

A new suggestion with the new value.

withPrefix

Suggestion withPrefix(String prefix)

Creates a new Suggestion based on this but changing the prefix

Parameters:

prefix - The prefix

Returns:

A new suggestion with the prefix changed.