org.xwiki.editor.tool.autocomplete
Class Hints

java.lang.Object
  org.xwiki.editor.tool.autocomplete.Hints

public class Hints
extends Object

Represents a list of hints that are returned.

Version:

$Id$

Constructor Summary

Hints()

Method Summary

SortedSet<HintData>	getHints()
int	getStartOffset()
boolean	isEmpty()
Hints	withHints(Collection<HintData> values) Build an instance of Hints.
Hints	withHints(HintData... values) Build an instance of Hints.
Hints	withHints(Hints otherHints) Build an instance of Hints.
Hints	withStartOffset(int startOffset) Build an instance of Hints.

Methods inherited from class java.lang.Object

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

Constructor Detail

Hints

public Hints()

Method Detail

getHints

public SortedSet<HintData> getHints()

Returns:

the autocompletion hints

withHints

public Hints withHints(HintData... values)

Build an instance of Hints.

Parameters:

values - the autocompletion hints to populate the instance with

Returns:

the Hints containing the passed hints

withHints

public Hints withHints(Collection<HintData> values)

Build an instance of Hints.

Parameters:

values - the autocompletion hints to populate the instance with

Returns:

the Hints containing the passed hints

getStartOffset

public int getStartOffset()

Returns:

the replaceFrom

withStartOffset

public Hints withStartOffset(int startOffset)

Build an instance of Hints.

Parameters:

startOffset - the start of the user input that needs to be replaced on the client side with the selected autocompletion hint.

Returns:

the Hints containing the passed hints

withHints

public Hints withHints(Hints otherHints)

Build an instance of Hints.

Parameters:

otherHints - another instance to populate this instance with

Returns:

the Hints containing also the hints from the passed instance

isEmpty

public boolean isEmpty()

Returns:

true if the list of hints is empty.