org.xwiki.editor.tool.autocomplete
Class HintData

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

All Implemented Interfaces:

Comparable<HintData>

public class HintData
extends Object
implements Comparable<HintData>

Represents hint data (name of hint and description of hint).

Version:

$Id$

Constructor Summary

HintData(String name, String description)

Method Summary

int	compareTo(HintData hintData)
boolean	equals(Object object)
String	getDescription()
String	getName()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HintData

public HintData(String name,
                String description)

Parameters:

name - see getName()

description - see getDescription()

Method Detail

getDescription

public String getDescription()

Returns:

the hint description

getName

public String getName()

Returns:

the hint name (ie what will get inserted if the user picks it)

compareTo

public int compareTo(HintData hintData)

Specified by:

compareTo in interface Comparable<HintData>

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object