public | SimpleScriptTokenInformation( Creates a new instance and initializes it with the specified description. |
public boolean | Indicates whether some other object is "equal to" this one. |
public PartitionedTextContent | Gets the description for the corresponding token if available. |
public String | Gets the identifier that is associated with this token information schema. |
public Map< | Gets the schema meta-data that is associated with the token information. |
public int | hashCode() Returns a hash code value for the object. |
public void | setSchemaIdentifier( Sets the schema identifier. |
public void | setSchemaMetaData( Sets the schema meta-data. |
The equals
method implements an equivalence relation on non-null object references:
- It is reflexive: for any non-null reference value
x
,x.equals(x)
should returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
The equals
method for class Object
implements the most discriminating possible equivalence
relation on objects; that is, for any non-null reference values x
and y
, this method returns
true
if and only if x
and y
refer to the same object (x == y
has the value
true
).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden,
so as to maintain the general contract for the hashCode
method, which states that equal objects must have
equal hash codes.
true
if this object is the same as the obj argument; false
otherwise.This is usually displayed when an user hovers the mouse pointer over a script token in the IDE, or explicitly requests information about it.
The schema identifiers are arbitrary strings that should uniquely identify the nature of the token information. It can be used by IDE plugins and others to interpret the token information and present the user a more readable display.
One use case for this is to create IDE plugins that add various icons for the information display.
E.g.:
"org.company.scripting.token.info"
null
if none.The meta-data can contain arbitrary key-value pairs that can be used to describe various aspects of the information. This is used to convey information to the IDE plugins about different aspects of the token information.
null
or empty.
The general contract of hashCode
is:
- Whenever it is invoked on the same object more than once during an execution of a Java application, the
hashCode
method must consistently return the same integer, provided no information used inequals
comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equals(Object)
method, then calling thehashCode
method on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal according to the
Object.equals(
Object) method, then calling thehashCode
method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
As much as is reasonably practical, the hashCode method defined by class Object
does return distinct
integers for distinct objects. (This is typically implemented by converting the internal address of the object
into an integer, but this implementation technique is not required by the Java™ programming language.)