org.raml.v2.internal.framework.suggester

Class DefaultSuggestion

java.lang.Object

org.raml.v2.internal.framework.suggester.DefaultSuggestion

All Implemented Interfaces:

Comparable<Suggestion>, Suggestion

public class DefaultSuggestion
extends Object
implements Suggestion, Comparable<Suggestion>

Field Summary

Fields

Modifier and Type	Field and Description
static String	RAML_1_0_HEADER

Constructor Summary

Constructors

Constructor and Description
DefaultSuggestion(String value, String description, String label)
DefaultSuggestion(String value, String description, String label, String prefix)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Suggestion other)
String	getDescription()
String	getLabel()
String	getPrefix()
String	getValue()
String	toString()
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 class java.lang.Object

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

Field Detail

RAML_1_0_HEADER

public static final String RAML_1_0_HEADER

See Also:

Constant Field Values

Constructor Detail

DefaultSuggestion

public DefaultSuggestion(String value,
                 String description,
                 String label)

DefaultSuggestion

public DefaultSuggestion(String value,
                 String description,
                 String label,
                 String prefix)

Method Detail

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface Suggestion

Returns:

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

getLabel

public String getLabel()

Specified by:

getLabel in interface Suggestion

Returns:

the label displayed as the suggestion

getDescription

public String getDescription()

Specified by:

getDescription in interface Suggestion

Returns:

short description of the suggestion

getValue

public String getValue()

Specified by:

getValue in interface Suggestion

Returns:

actual value added by the editor

withDescription

public Suggestion withDescription(String description)

Description copied from interface: Suggestion

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

Specified by:

withDescription in interface Suggestion

Parameters:

description - The new description

Returns:

A new suggestion with the new description.

withValue

public Suggestion withValue(String value)

Description copied from interface: Suggestion

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

Specified by:

withValue in interface Suggestion

Parameters:

value - The new value

Returns:

A new suggestion with the new value.

withPrefix

public Suggestion withPrefix(String prefix)

Description copied from interface: Suggestion

Creates a new Suggestion based on this but changing the prefix

Specified by:

withPrefix in interface Suggestion

Parameters:

prefix - The prefix

Returns:

A new suggestion with the prefix changed.

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(Suggestion other)

Specified by:

compareTo in interface Comparable<Suggestion>