xtc.type
Class PointerT

java.lang.Object
  xtc.tree.Node
      xtc.type.Type
          xtc.type.DerivedT
              xtc.type.PointerT

All Implemented Interfaces:

java.lang.Iterable<java.lang.Object>, Locatable

public class PointerT
extends DerivedT

A pointer type.

Version:

$Revision: 1.31 $

Author:

Robert Grimm

Nested Class Summary

Nested classes/interfaces inherited from class xtc.type.Type

Type.Tag

Field Summary

static PointerT

TO_VOID The canonical pointer to void.

Constructor Summary

PointerT(Type type)
Create a new pointer type.

PointerT(Type template, Type type)
Create a new pointer type.

Method Summary

PointerT	copy() Create a deep copy of this type.
boolean	equals(java.lang.Object o)
Type	getType() Get the pointed-to type.
int	hashCode()
boolean	isPointer() Determine whether this type is a pointer.
Type	seal() Seal this type.
Type.Tag	tag() Get this type's tag.
PointerT	toPointer() Get this type as a pointer.
void	write(java.lang.Appendable out) Write a human readable representation to the specified appendable.

Methods inherited from class xtc.type.DerivedT

isDerived

Methods inherited from class xtc.type.Type

addAttribute, annotate, attribute, attribute, attribute, attributes, cast, checkNotSealed, constant, constant, copy, deannotate, getAttribute, getAttribute, getConstant, getConstant, getLanguage, getLanguage, getLocation, getLocation, getScope, getScope, getShape, getShape, hasAlias, hasAnnotated, hasAttribute, hasAttribute, hasAttribute, hasAttribute, hasAttributes, hasConstant, hasConstant, hasEnum, hasEnumerator, hasError, hasInstantiated, hasLanguage, hasLanguage, hasLocation, hasLocation, hasParameterized, hasScope, hasScope, hasShape, hasShape, hasStructOrUnion, hasTag, hasTagged, hasVariable, hasWTag, isAlias, isAnnotated, isArray, isBoolean, isClass, isConcrete, isEnum, isEnumerator, isError, isFloat, isFunction, isInstantiated, isInteger, isInterface, isInternal, isInternalParameter, isLabel, isMethod, isNamedParameter, isNumber, isPackage, isParameter, isParameterized, isSealed, isStruct, isTuple, isUnion, isUnit, isVariable, isVariant, isVoid, isWildcard, isWrapped, language, locate, locate, mark, properties, removeAttribute, removeProperty, resolve, resolve, scope, seal, setLocation, setLocation, setProperty, shape, shape, toAlias, toAnnotated, toArray, toBoolean, toClass, toEnum, toEnumerator, toFloat, toFunction, toInstantiated, toInteger, toInterface, toInternal, toInternalParameter, toLabel, toMethod, toNamedParameter, toNumber, toPackage, toParameter, toParameterized, toStruct, toStructOrUnion, toTagged, toTuple, toUnion, toUnit, toVariable, toVariant, toVoid, toWildcard, toWrapped, trace, wtag

Methods inherited from class xtc.tree.Node

add, add, addAll, addAll, addAll, addAll, addAllTo, addNode, contains, get, getBoolean, getBooleanProperty, getGeneric, getList, getName, getNode, getProperty, getString, getStringProperty, getTokenText, hasName, hasProperty, hasTraversal, indexOf, isAnnotation, isEmpty, isGeneric, isList, isToken, iterator, lastIndexOf, remove, set, size, strip, toAnnotation, toList, toString, toToken

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TO_VOID

public static final PointerT TO_VOID

The canonical pointer to void.

Constructor Detail

PointerT

public PointerT(Type type)

Create a new pointer type.

Parameters:

type - The pointed-to type.

PointerT

public PointerT(Type template,
                Type type)

Create a new pointer type.

Parameters:

template - The type whose annotations to copy.

type - The pointed-to type.

Method Detail

copy

public PointerT copy()

Description copied from class: Type

Create a deep copy of this type. The resulting type is not sealed.

Specified by:

copy in class Type

Returns:

A deep copy of this type.

seal

public Type seal()

Description copied from class: Type

Seal this type. Subclasses that reference other types must override this method and, if the instance is not sealed, first invoke the superclass' version and then seal all referenced types. For example, if a subclass references a single type type, the corresponding overridden method reads:

 public Type seal() {
   if (! isSealed()) {
     super.seal();
     type.seal();
   }
   return this;
 }
 

First testing whether a type is sealed and then invoking the superclass' seal() method avoids infinite recursions for mutually recursive types.

Overrides:

seal in class Type

Returns:

This type.

See Also:

Type.seal(List)

tag

public Type.Tag tag()

Description copied from class: Type

Get this type's tag. Invocations to this method are forwarded across wrapped types.

Specified by:

tag in class Type

Returns:

This type's tag.

See Also:

Type.wtag()

isPointer

public boolean isPointer()

Description copied from class: Type

Determine whether this type is a pointer.

Overrides:

isPointer in class Type

Returns:

true if this type is a pointer.

toPointer

public PointerT toPointer()

Description copied from class: Type

Get this type as a pointer.

Overrides:

toPointer in class Type

Returns:

This type as a pointer.

getType

public Type getType()

Get the pointed-to type.

Returns:

The pointed-to type.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

write

public void write(java.lang.Appendable out)
           throws java.io.IOException

Description copied from class: Node

Write a human readable representation to the specified appendable. If this node supports generic traversal, the default implementation writes this node in algebraic term-format; otherwise, it writes the string returned by Object.toString().

Overrides:

write in class Node

Parameters:

out - The appendable.

Throws:

java.io.IOException - Signals an I/O error.