SimpleLiteralInformation

package saker.build.scripting.model.info

public class SimpleLiteralInformation implements LiteralInformation, Externalizable

saker.build.scripting.model.info.SimpleLiteralInformation

java.lang.Object

saker.build.scripting.model.info.LiteralInformation

saker.build.scripting.model.info.InformationHolder

java.io.Externalizable

java.io.Serializable

Simple LiteralInformation data class.

Constructors

public	SimpleLiteralInformation() For Externalizable.
public	SimpleLiteralInformation(String literal) Construct a new instance for the given literal.

Methods

public FormattedTextContent	getInformation() Gets information about this literal.
public String	getLiteral() Gets a string representation of the literal.
public String	getRelation() Gets the relation of this literal.
public TypeInformation	getType() Gets the type of the literal.
public boolean	isDeprecated() Gets if the literal is deprecated.
public void	readExternal(ObjectInput in) 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	setDeprecated(boolean deprecated) Sets the deprecated flag for this literal.
public void	setInformation(FormattedTextContent information) Sets the information for this literal.
public void	setLiteral(String literal) Sets the literal.
public void	setRelation(String relation) Sets the relation information.
public void	setType(TypeInformation type) Sets the type of this literal.
public String	toString() Returns a string representation of the object.
public void	writeExternal(ObjectOutput out) 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 clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

public SimpleLiteralInformation()

For Externalizable.

public SimpleLiteralInformation(String literal)

Construct a new instance for the given literal.

literalThe literal.

getLiteral()

public FormattedTextContent getInformation()

Overridden from: LiteralInformation

Gets information about this literal.

The information should contain general description about the literal, its context, and what it represents.

The information about this literal.

public String getLiteral()

Overridden from: LiteralInformation

Gets a string representation of the literal.

The string representation of the literal.

public String getRelation()

Overridden from: LiteralInformation

Gets the relation of this literal.

Relation is a short information about associated with the literal. It is optional and in most cases the type information is enough. However, in some cases it might be useful for the user to provide additional information related to the literal.

The returned string should be short, fit on a single line.

The relation of the literal or null if none.

ScriptCompletionProposal.getDisplayRelation()

public TypeInformation getType()

Overridden from: LiteralInformation

Gets the type of the literal.

The type of the literal or null if not available.

public boolean isDeprecated()

Overridden from: LiteralInformation

Gets if the literal is deprecated.

true if the literal is deprecated.

public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

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 setDeprecated(boolean deprecated)

Sets the deprecated flag for this literal.

deprecatedtrue if deprecated.

isDeprecated()

public void setInformation(FormattedTextContent information)

Sets the information for this literal.

informationThe information.

getInformation()

public void setLiteral(String literal)

Sets the literal.

literalThe literal.

getLiteral()

public void setRelation(String relation)

Sets the relation information.

relationThe relation.

getRelation()

public void setType(TypeInformation type)

Sets the type of this literal.

typeThe type.

getType()

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