The class is mutable.
public | Creates a new uninitialized instance. |
public | SimpleScriptStructureOutline( Creates a new instance and initializes it with the given root outline entries. |
public void | addSchemaMetaData( Ads a schema meta-data key-value pair for the outline. |
public boolean | Indicates whether some other object is "equal to" this one. |
public List< | Gets the top level root entries in this outline. |
public String | Gets the identifier string that is associated with the outline schema. |
public Map< | Gets the schema meta-data that is associated with the outline. |
public int | hashCode() Returns a hash code value for the object. |
public void | The object implements the readExternal method to restore its
contents by calling the methods of DataInput for primitive
types and readObject for objects, strings and arrays. |
public void | setRootEntries( Sets the root entries of the outline. |
public void | setSchemaIdentifier( Sets the schema identifier for the outline. |
public String | toString() Returns a string representation of the object. |
public void | The object implements the writeExternal method to save its contents
by calling the methods of DataOutput for its primitive values or
calling the writeObject method of ObjectOutput for objects, strings,
and arrays. |
Also used by Externalizable.
null
.
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.null
.)The schema identifiers are arbitrary strings that should uniquely identify the structure of the enclosed outline. It can be used by IDE plugins and others to interpret the outline structure and present the user a more readable display.
One use case for this is to create IDE plugins that assign various icons for the script outline to display.
The schema identifier can be provided by the scripting language, can be arbitrary, and should be unique among other scripting languages.
E.g.:
"org.company.scripting.language.outline"
null
if none.The meta-data can contain arbitrary key-value pairs that can be used to describe various aspects of the outline. This is used to convey information to the IDE plugins about different aspects of the outline.
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.)
toString
method returns a string that
"textually represents" this object. The result should be a concise but informative representation that is easy
for a person to read. It is recommended that all subclasses override this method.
The toString
method for class Object
returns a string consisting of the name of the class of
which the object is an instance, the at-sign character `@
', and the unsigned hexadecimal representation
of the hash code of the object. In other words, this method returns a string equal to the value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())