SimpleFieldInformation

package saker.build.scripting.model.info

public class SimpleFieldInformation implements FieldInformation, Externalizable

saker.build.scripting.model.info.SimpleFieldInformation

java.lang.Object

saker.build.scripting.model.info.FieldInformation

saker.build.scripting.model.info.InformationHolder

java.io.Externalizable

java.io.Serializable

Simple FieldInformation data class.

Constructors

public	SimpleFieldInformation(String name) Creates a new instance with the specified field name.

Methods

public FormattedTextContent	getInformation() Gets documentational information about this field.
public String	getName() Gety the name of this field.
public TypeInformation	getType() Gets the type of the field.
public boolean	isDeprecated() Gets if the field 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 field.
public void	setInformation(FormattedTextContent information) Sets the documentational information for this field.
public void	setType(TypeInformation type) Sets the type of this field information.
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 SimpleFieldInformation(String name)

Creates a new instance with the specified field name.

nameThe field name.

public FormattedTextContent getInformation()

Overridden from: FieldInformation

Gets documentational information about this field.

The information.

public String getName()

Overridden from: FieldInformation

Gety the name of this field.

The name.

public TypeInformation getType()

Overridden from: FieldInformation

Gets the type of the field.

The type of the field or null if not available.

public boolean isDeprecated()

Overridden from: FieldInformation

Gets if the field is deprecated.

true if the field 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 field.

deprecatedtrue if deprecated.

isDeprecated()

public void setInformation(FormattedTextContent information)

Sets the documentational information for this field.

informationThe information.

getInformation()

public void setType(TypeInformation type)

Sets the type of this field information.

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