saker.build Documentation TaskDoc JavaDoc Packages
public class SimpleScriptTokenInformation implements ScriptTokenInformation
Simple data class implementation of ScriptTokenInformation.
Constructors
public
Creates a new instance and initializes it with the specified description.
Methods
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<String, String>
Gets the schema meta-data that is associated with the token information.
public int
Returns a hash code value for the object.
public void
setSchemaIdentifier(String schemaIdentifier)
public void
Creates a new instance and initializes it with the specified description.
descriptionThe description.
public boolean equals(Object obj)
Overridden from: Object
Indicates whether some other object is "equal to" this one.

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 return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

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.

objthe reference object with which to compare.
true if this object is the same as the obj argument; false otherwise.
Overridden from: ScriptTokenInformation
Gets the description for the corresponding token if available.

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 description.
Overridden from: ScriptTokenInformation
Gets the identifier that is associated with this token information schema.

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"
 
The schema identifier or null if none.
Overridden from: ScriptTokenInformation
Gets the schema meta-data that is associated with the token information.

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.

The meta-data for the token information. May be null or empty.
public int hashCode()
Overridden from: Object
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

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 in equals 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 the hashCode 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 the hashCode 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.)

a hash code value for this object.
public void setSchemaIdentifier(String schemaIdentifier)
schemaIdentifierThe schema identifier.
public void setSchemaMetaData(Map<String, String> schemaMetaData)
schemaMetaDataThe schema meta-data.