SimpleTextPartition

public class SimpleTextPartition implements TextPartition

saker.build.scripting.model.SimpleTextPartition

java.lang.Object

saker.build.scripting.model.TextPartition

A simple TextPartition implementation holding the data passed to it.

Constructors

public	SimpleTextPartition(String title, String subTitle, FormattedTextContent content) Creates a new instance with the given values.

Methods

public boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
public FormattedTextContent	getContent() Gets the text body content for the partition.
public String	getSchemaIdentifier() Gets the identifier that is associated with this text partition schema.
public Map<String, String>	getSchemaMetaData() Gets the schema meta-data that is associated with the text partition.
public String	getSubTitle() Gets the subtitle of the partition.
public String	getTitle() Gets the title of the partition.
public int	hashCode() Returns a hash code value for the object.
public void	setSchemaIdentifier(String schemaIdentifier) Sets the schema identifier.
public void	setSchemaMetaData(Map<String, String> schemaMetaData) Sets the schema meta-data.
public String	toString() Returns a string representation of the object.

Inherited methods
From: Object clone, finalize, getClass, notify, notifyAll, wait, wait, wait

public SimpleTextPartition(String title, String subTitle, FormattedTextContent content)

Creates a new instance with the given values.

titleThe title of the partition.

subTitleThe subtitle of the partition.

contentThe text body contents for the partition.

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.

Object.hashCode()

HashMap

public FormattedTextContent getContent()

Overridden from: TextPartition

Gets the text body content for the partition.

The contents of the partition, or null if not defined.

public String getSchemaIdentifier()

Overridden from: TextPartition

Gets the identifier that is associated with this text partition schema.

The schema identifiers are arbitrary strings that should uniquely identify the nature of the text partition. It can be used by IDE plugins and others to interpret the text partition and present the user a more readable display.

One use case for this is to create IDE plugins that add various icons for the text display.

E.g.:

 "org.company.scripting.text"

The schema identifier or null if none.

public Map<String, String> getSchemaMetaData()

Overridden from: TextPartition

Gets the schema meta-data that is associated with the text partition.

The meta-data can contain arbitrary key-value pairs that can be used to describe various aspects of the partition. This is used to convey information to the IDE plugins about different aspects of the text partition.

The meta-data for the text partition. May be null or empty.

TextPartition.getSchemaIdentifier()

public String getSubTitle()

Overridden from: TextPartition

Gets the subtitle of the partition.

The subtitle, or null if not defined.

public String getTitle()

Overridden from: TextPartition

Gets the title of the partition.

The title, or null if not defined.

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.

Object.equals(Object)

System.identityHashCode(Object)

public void setSchemaIdentifier(String schemaIdentifier)

Sets the schema identifier.

schemaIdentifierThe schema identifier.

public void setSchemaMetaData(Map<String, String> schemaMetaData)

Sets the schema meta-data.

schemaMetaDataThe meta-data.

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.