saker.build Documentation TaskDoc JavaDoc Packages
public class SimpleScriptStructureOutline implements ScriptStructureOutline, Externalizable
Data class implementation of ScriptStructureOutline.

The class is mutable.

Constructors
public
Creates a new uninitialized instance.
public
Creates a new instance and initializes it with the given root outline entries.
Methods
public void
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<extends StructureOutlineEntry>
Gets the top level root entries in this outline.
public String
Gets the identifier string that is associated with the outline schema.
public Map<String, String>
Gets the schema meta-data that is associated with the outline.
public int
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(List<extends StructureOutlineEntry> rootEntries)
Sets the root entries of the outline.
public void
setSchemaIdentifier(String schemaIdentifier)
Sets the schema identifier for the outline.
public String
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.
Inherited methods
From: Object
Creates a new uninitialized instance.

Also used by Externalizable.

Creates a new instance and initializes it with the given root outline entries.
rootEntriesThe root entries.
public void addSchemaMetaData(String key, String value) throws NullPointerException
Ads a schema meta-data key-value pair for the outline.
keyThe key of the meta-data.
valueThe value of the meta-data.
NullPointerExceptionIf the key is null.
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: ScriptStructureOutline
Gets the top level root entries in this outline.
The entries. (May be null.)
Overridden from: ScriptStructureOutline
Gets the identifier string that is associated with the outline schema.

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

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.

The meta-data for the outline. 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.
Overridden from: Externalizable
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. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.
inthe stream to read data from in order to restore the object
IOExceptionif I/O errors occur
ClassNotFoundExceptionIf the class for an object being restored cannot be found.
public void setRootEntries(List<extends StructureOutlineEntry> rootEntries)
Sets the root entries of the outline.
rootEntriesThe root entries.
public void setSchemaIdentifier(String schemaIdentifier)
Sets the schema identifier for the outline.
schemaIdentifierThe schema identifier.
public String toString()
Overridden from: Object
Returns a string representation of the object. In general, the 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())
 
a string representation of the object.
public void writeExternal(ObjectOutput out) throws IOException
Overridden from: Externalizable
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.
outthe stream to write the object to
IOExceptionIncludes any I/O exceptions that may occur