SimpleTypeInformation

package saker.build.scripting.model.info

public class SimpleTypeInformation implements TypeInformation, Externalizable

saker.build.scripting.model.info.SimpleTypeInformation

java.lang.Object

saker.build.scripting.model.info.TypeInformation

saker.build.scripting.model.info.InformationHolder

java.io.Externalizable

java.io.Serializable

Simple TypeInformation data class.

Constructors

public	SimpleTypeInformation() For Externalizable.
public	SimpleTypeInformation(String kind) Creates a new instance for the given type information kind.

Methods

public List<? extends TypeInformation>	getElementTypes() Gets the type information about the element types of this type.
public Map<String, FieldInformation>	getEnumValues() Gets information about what kind of enumeration values this type decalres.
public Map<String, FieldInformation>	getFields() Gets information about the fields this type has.
public FormattedTextContent	getInformation() Gets documentational information about this type.
public String	getKind() Gets the kind of the type.
public Set<TypeInformation>	getRelatedTypes() Gets a collection of related types to this type information.
public Set<TypeInformation>	getSuperTypes() Gets the super types of this type.
public String	getTypeQualifiedName() Gets the qualified name of the type.
public String	getTypeSimpleName() Gets the simple name of the type.
public boolean	isDeprecated() Gets if the type 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 type.
public void	setElementTypes(List<? extends TypeInformation> elementTypes) Sets the element types for this type.
public void	setEnumValues(Map<String, FieldInformation> enumValues) Sets the enumeration values for this type.
public void	setFields(Map<String, FieldInformation> fields) Sets the field for this type.
public void	setInformation(FormattedTextContent information) Sets the documentational information for this type.
public void	setKind(String kind) Sets the type kind for this type.
public void	setRelatedTypes(Set<TypeInformation> relatedTypes) Sets the related types for this type.
public void	setSuperTypes(Set<TypeInformation> superTypes) Sets the super types for this type.
public void	setTypeQualifiedName(String qualifiedName) Sets the qualified name of the type.
public void	setTypeSimpleName(String simpleName) Sets the simple name of the type.
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 SimpleTypeInformation()

For Externalizable.

public SimpleTypeInformation(String kind)

Creates a new instance for the given type information kind.

kindThe kind.

getKind()

public List<? extends TypeInformation> getElementTypes()

Overridden from: TypeInformation

Gets the type information about the element types of this type.

See TypeInformationKind.COLLECTION and TypeInformationKind.MAP for more information.

The elements in the returned list may be null to represent that a given element type at the index is unknown, unspecified, or doesn't have a specific type.

An unmodifiable list of element types for this type.

public Map<String, FieldInformation> getEnumValues()

Overridden from: TypeInformation

Gets information about what kind of enumeration values this type decalres.

The returned informations usually have their types as this type.

An unmodifiable map of enumeration value informations or null if not available.

public Map<String, FieldInformation> getFields()

Overridden from: TypeInformation

Gets information about the fields this type has.

An unmodifiable map of field informations or null if not available.

public FormattedTextContent getInformation()

Overridden from: TypeInformation

Gets documentational information about this type.

The information.

public String getKind()

Overridden from: TypeInformation

Gets the kind of the type.

The kind determines how the consumer should handle this type information.

The type kind.

public Set<TypeInformation> getRelatedTypes()

Overridden from: TypeInformation

Gets a collection of related types to this type information.

Related types are which can be used in similar contexts as this type. E.g. If the type of a parameter is T, and if type E can be used as a value to assign to the parameter with type T, then E can be considered to be related to T, as it can be used in the same place as type T.

The related types should be chosen carefully, and only when appropriate. Script models might use these types to provide additional suggestions when satisfying type requirements, therefore returning unrelated types for these suggestions might result in runtime errors.

Super types should not be included in the results.

The related types.

public Set<TypeInformation> getSuperTypes()

Overridden from: TypeInformation

Gets the super types of this type.

Any direct superclasses and superinterfaces should be returned in this method. Transitive superclasses and superinterfaces may be too, but not required.

An unmodifiable set of supertypes or null if not available.

public String getTypeQualifiedName()

Overridden from: TypeInformation

Gets the qualified name of the type.

The qualified name of the type, or null if not applicable or not available.

public String getTypeSimpleName()

Overridden from: TypeInformation

Gets the simple name of the type.

The simple name of the type or null if not available.

public boolean isDeprecated()

Overridden from: TypeInformation

Gets if the type is deprecated.

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

deprecatedtrue if deprecated.

isDeprecated()

public void setElementTypes(List<? extends TypeInformation> elementTypes)

Sets the element types for this type.

elementTypesThe element types.

getElementTypes()

public void setEnumValues(Map<String, FieldInformation> enumValues)

Sets the enumeration values for this type.

enumValuesThe enumeration values.

getEnumValues()

public void setFields(Map<String, FieldInformation> fields)

Sets the field for this type.

fieldsThe fields.

getFields()

public void setInformation(FormattedTextContent information)

Sets the documentational information for this type.

informationThe information.

getInformation()

public void setKind(String kind)

Sets the type kind for this type.

kindThe kind.

getKind()

public void setRelatedTypes(Set<TypeInformation> relatedTypes)

Sets the related types for this type.

relatedTypesThe related types.

getRelatedTypes()

public void setSuperTypes(Set<TypeInformation> superTypes)

Sets the super types for this type.

superTypesThe super types.

getSuperTypes()

public void setTypeQualifiedName(String qualifiedName)

Sets the qualified name of the type.

qualifiedNameThe qualified name.

getTypeQualifiedName()

public void setTypeSimpleName(String simpleName)

Sets the simple name of the type.

simpleNameThe simple name.

getTypeSimpleName()

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