recoder.abstraction
Class ArrayType

java.lang.Object
  recoder.abstraction.ArrayType

All Implemented Interfaces:

ClassType, ClassTypeContainer, Member, ProgramModelElement, Type, AccessFlags, ModelElement, NamedModelElement

public final class ArrayType
extends java.lang.Object
implements ClassType

A program model element representing array types.

Author:

AL, RN

Nested Class Summary

class	ArrayType.ArrayCloneMethod
class	ArrayType.ArrayLengthField

Nested classes/interfaces inherited from interface recoder.abstraction.ProgramModelElement

ProgramModelElement.LexicalOrder

Nested classes/interfaces inherited from interface recoder.abstraction.ProgramModelElement

ProgramModelElement.LexicalOrder

Nested classes/interfaces inherited from interface recoder.abstraction.ProgramModelElement

ProgramModelElement.LexicalOrder

Field Summary

Fields inherited from interface recoder.abstraction.ProgramModelElement

LEXICAL_ORDER

Fields inherited from interface recoder.bytecode.AccessFlags

ABSTRACT, ANNOTATION, BRIDGE, ENUM, FINAL, INTERFACE, NATIVE, PRIVATE, PROTECTED, PUBLIC, STATIC, STRICT, SUPER, SYNCHRONIZED, SYNTHETIC, TRANSIENT, VARARGS, VOLATILE

Fields inherited from interface recoder.abstraction.ProgramModelElement

LEXICAL_ORDER

Fields inherited from interface recoder.bytecode.AccessFlags

ABSTRACT, ANNOTATION, BRIDGE, ENUM, FINAL, INTERFACE, NATIVE, PRIVATE, PROTECTED, PUBLIC, STATIC, STRICT, SUPER, SYNCHRONIZED, SYNTHETIC, TRANSIENT, VARARGS, VOLATILE

Fields inherited from interface recoder.abstraction.ProgramModelElement

LEXICAL_ORDER

Fields inherited from interface recoder.bytecode.AccessFlags

ABSTRACT, ANNOTATION, BRIDGE, ENUM, FINAL, INTERFACE, NATIVE, PRIVATE, PROTECTED, PUBLIC, STATIC, STRICT, SUPER, SYNCHRONIZED, SYNTHETIC, TRANSIENT, VARARGS, VOLATILE

Constructor Summary

ArrayType(Type basetype, ImplicitElementInfo pmi)
Creates a new array type for the given base type, organized by the given program model info.

Method Summary

ArrayType	createArrayType()
boolean	equals(java.lang.Object o2)
java.util.List<Field>	getAllFields() Returns all visible fields that are defined in this class type or any of its supertypes.
java.util.List<Method>	getAllMethods() Returns all visible methods that are defined in this class type or any of its supertypes.
java.util.List<ClassType>	getAllSupertypes() Returns the list of all supertypes of this class type, in topological order, including the class type itself as first element.
java.util.List<ClassType>	getAllTypes() Returns all class types that are inner types of this class type, including visible inherited types.
java.util.List<? extends AnnotationUse>	getAnnotations() Returns a list of Annotations.
ArrayType.ArrayCloneMethod	getArrayCloneMethod()
ArrayType.ArrayLengthField	getArrayLengthField()
ArrayType	getArrayType()
Type	getBaseType() Returns the base type of this array type.
java.lang.String	getBinaryName() Returns the binary name.
java.util.List<? extends Constructor>	getConstructors() Returns the constructors locally defined within this class type.
ClassTypeContainer	getContainer() Returns the enclosing package or class type, or method.
ClassType	getContainingClassType() Returns the logical parent type of this member.
ErasedType	getErasedType()
java.util.List<? extends Field>	getFields() Returns the fields locally defined within this class type.
java.lang.String	getFullName() Returns the maximal expanded name including all applicable qualifiers.
java.lang.String	getFullSignature() Returns a full type signature of this type, i.e., the full name plus possible type arguments.
java.util.List<Method>	getMethods() Returns the methods locally defined within this class type.
java.lang.String	getName() Returns the name of this array type.
Package	getPackage() Returns the package this element is defined in.
ProgramModelInfo	getProgramModelInfo() Returns the instance that can retrieve information about this program model element.
java.util.List<ClassType>	getSupertypes() Returns the list of locally declared supertypes of this class type.
java.util.List<? extends TypeParameter>	getTypeParameters() Returns the type parameters of this class type.
java.util.List<? extends ClassType>	getTypes() Returns the class types locally defined within this container.
int	hashCode()
boolean	isAbstract() Checks if this member is abstract.
boolean	isAnnotationType() Checks if this class type denotes an annotation type
boolean	isEnumType() Checks if this class type denotes an enum type
boolean	isFinal() Checks if this member is final.
boolean	isInner() Checks if this type is an inner class, as described in JLS, 3rd edition, §8.1.3
boolean	isInterface() Checks if this class type denotes an interface (i.e. ordinary interface or annotation type).
boolean	isOrdinaryClass() Checks if this class type denotes an ordinary (i.e. not an enum) class.
boolean	isOrdinaryInterface() Checks if this class type denotes an ordinary (i.e. not annotation type) interface.
boolean	isPrivate() Checks if this member is private.
boolean	isProtected() Checks if this member is protected.
boolean	isPublic() Checks if this member is public.
boolean	isStatic() Checks if this member is static.
boolean	isStrictFp() Checks if this member is strictfp.
void	setProgramModelInfo(ProgramModelInfo service) Sets the instance that can retrieve information about this program model element.
java.lang.String	toString()
void	validate() Check consistency and admissibility of a construct, e.g. cardinality of participants.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArrayType

public ArrayType(Type basetype,
                 ImplicitElementInfo pmi)

Creates a new array type for the given base type, organized by the given program model info.

Parameters:

basetype - the base type of the array.

pmi - the program model info responsible for this type.

Method Detail

getArrayType

public ArrayType getArrayType()

Specified by:

getArrayType in interface Type

Returns:

createArrayType

public ArrayType createArrayType()

Specified by:

createArrayType in interface Type

Returns:

getArrayLengthField

public ArrayType.ArrayLengthField getArrayLengthField()

getArrayCloneMethod

public ArrayType.ArrayCloneMethod getArrayCloneMethod()

getBaseType

public Type getBaseType()

Returns the base type of this array type.

Returns:

the base type.

getName

public java.lang.String getName()

Returns the name of this array type.

Specified by:

getName in interface NamedModelElement

Returns:

the name of this type.

getFullName

public java.lang.String getFullName()

Returns the maximal expanded name including all applicable qualifiers.

Specified by:

getFullName in interface ProgramModelElement

Returns:

the full name of this program model element.

getBinaryName

public java.lang.String getBinaryName()

Description copied from interface: ProgramModelElement

Returns the binary name. The binary name is the name this program model element would have in bytecode, i.e., how it either is read by the bytecode parser, or the name a compiler would give this element during the compilation process (if this program model element is represented in source code). See JLS, §13.1

Specified by:

getBinaryName in interface ProgramModelElement

Returns:

the bytecode name of this program model element

getProgramModelInfo

public ProgramModelInfo getProgramModelInfo()

Returns the instance that can retrieve information about this program model element.

Specified by:

getProgramModelInfo in interface ProgramModelElement

Returns:

the program model info of this element.

setProgramModelInfo

public void setProgramModelInfo(ProgramModelInfo service)

Sets the instance that can retrieve information about this program model element.

Specified by:

setProgramModelInfo in interface ProgramModelElement

Parameters:

service - the program model info for this element.

validate

public void validate()

Description copied from interface: ModelElement

Check consistency and admissibility of a construct, e.g. cardinality of participants. Should only check syntactical correctness, not semantical correctness.
For checking, e.g., if an AST element of type recoder.java.statement.If has a boolean parameter as condition, recoder.service.SemanticsChecker

Specified by:

validate in interface ModelElement

See Also:

SemanticsChecker

equals

public boolean equals(java.lang.Object o2)

Overrides:

equals in class java.lang.Object

getAllFields

public java.util.List<Field> getAllFields()

Description copied from interface: ClassType

Returns all visible fields that are defined in this class type or any of its supertypes. The fields are in topological order with respect to the inheritance hierarchy.

Specified by:

getAllFields in interface ClassType

Returns:

the list of visible field members of this type and its supertypes.

getAllMethods

public java.util.List<Method> getAllMethods()

Description copied from interface: ClassType

Returns all visible methods that are defined in this class type or any of its supertypes. The methods are in topological order with respect to the inheritance hierarchy.

Specified by:

getAllMethods in interface ClassType

Returns:

the list of visible methods of this type and its supertypes.

getAllSupertypes

public java.util.List<ClassType> getAllSupertypes()

Description copied from interface: ClassType

Returns the list of all supertypes of this class type, in topological order, including the class type itself as first element. The order allows to resolve member overloading or overloading.

Specified by:

getAllSupertypes in interface ClassType

Returns:

the list of all supertypes of this type in topological order.

getAllTypes

public java.util.List<ClassType> getAllTypes()

Description copied from interface: ClassType

Returns all class types that are inner types of this class type, including visible inherited types.

Specified by:

getAllTypes in interface ClassType

Returns:

a list of class types that are members of this type or any of its supertypes.

See Also:

ClassType.getAllSupertypes()

getConstructors

public java.util.List<? extends Constructor> getConstructors()

Description copied from interface: ClassType

Returns the constructors locally defined within this class type.

Specified by:

getConstructors in interface ClassType

Returns:

the list of constructors of this type.

getFields

public java.util.List<? extends Field> getFields()

Description copied from interface: ClassType

Returns the fields locally defined within this class type.

Specified by:

getFields in interface ClassType

Returns:

the list of field members of this type.

getMethods

public java.util.List<Method> getMethods()

Description copied from interface: ClassType

Returns the methods locally defined within this class type.

Specified by:

getMethods in interface ClassType

Returns:

the list of methods of this type.

getSupertypes

public java.util.List<ClassType> getSupertypes()

Description copied from interface: ClassType

Returns the list of locally declared supertypes of this class type.

Specified by:

getSupertypes in interface ClassType

Returns:

the list of locally defined supertypes of this type.

getTypeParameters

public java.util.List<? extends TypeParameter> getTypeParameters()

Description copied from interface: ClassType

Returns the type parameters of this class type.

Specified by:

getTypeParameters in interface ClassType

Returns:

the list of type parameters of this class type.

isAbstract

public boolean isAbstract()

Description copied from interface: ClassType

Checks if this member is abstract. An interface will report true .

Specified by:

isAbstract in interface ClassType

Returns:

true if this member is abstract, false otherwise.

See Also:

ClassType.isInterface()

isAnnotationType

public boolean isAnnotationType()

Description copied from interface: ClassType

Checks if this class type denotes an annotation type

Specified by:

isAnnotationType in interface ClassType

Returns:

true if this object represents an annotation type, false otherwise

isEnumType

public boolean isEnumType()

Description copied from interface: ClassType

Checks if this class type denotes an enum type

Specified by:

isEnumType in interface ClassType

Returns:

true if this object represents an enum type, false otherwise

isInterface

public boolean isInterface()

Description copied from interface: ClassType

Checks if this class type denotes an interface (i.e. ordinary interface or annotation type).

Specified by:

isInterface in interface ClassType

Returns:

true if this object represents an interface, false otherwise.

isOrdinaryClass

public boolean isOrdinaryClass()

Description copied from interface: ClassType

Checks if this class type denotes an ordinary (i.e. not an enum) class.

Specified by:

isOrdinaryClass in interface ClassType

Returns:

true if this object represents an ordinary class type, false otherwise

isOrdinaryInterface

public boolean isOrdinaryInterface()

Description copied from interface: ClassType

Checks if this class type denotes an ordinary (i.e. not annotation type) interface.

Specified by:

isOrdinaryInterface in interface ClassType

Returns:

true if this object represents an ordinary interface, false otherwise.

getAnnotations

public java.util.List<? extends AnnotationUse> getAnnotations()

Description copied from interface: Member

Returns a list of Annotations.

Specified by:

getAnnotations in interface Member

Returns:

the annotations

getContainingClassType

public ClassType getContainingClassType()

Description copied from interface: Member

Returns the logical parent type of this member.

Specified by:

getContainingClassType in interface Member

Returns:

the class type containing this member.

isFinal

public boolean isFinal()

Description copied from interface: Member

Checks if this member is final.

Specified by:

isFinal in interface Member

Returns:

true if this member is final, false otherwise.

isPrivate

public boolean isPrivate()

Description copied from interface: Member

Checks if this member is private.

Specified by:

isPrivate in interface Member

Returns:

true if this member is private, false otherwise.

isProtected

public boolean isProtected()

Description copied from interface: Member

Checks if this member is protected.

Specified by:

isProtected in interface Member

Returns:

true if this member is protected, false otherwise.

isPublic

public boolean isPublic()

Description copied from interface: Member

Checks if this member is public.

Specified by:

isPublic in interface Member

Returns:

true if this member is public, false otherwise.

isStatic

public boolean isStatic()

Description copied from interface: Member

Checks if this member is static. Returns true for Constructors.

Specified by:

isStatic in interface Member

Returns:

true if this member is static, false otherwise.

isStrictFp

public boolean isStrictFp()

Description copied from interface: Member

Checks if this member is strictfp.

Specified by:

isStrictFp in interface Member

Returns:

true if this member is strictfp, false otherwise.

getContainer

public ClassTypeContainer getContainer()

Description copied from interface: ClassTypeContainer

Returns the enclosing package or class type, or method. A package will report null, a methods its enclosing class.

Specified by:

getContainer in interface ClassTypeContainer

Returns:

the container of this element.

getPackage

public Package getPackage()

Description copied from interface: ClassTypeContainer

Returns the package this element is defined in. Packages have no recursive scope and report themselves.

Specified by:

getPackage in interface ClassTypeContainer

Returns:

the package of this element.

getTypes

public java.util.List<? extends ClassType> getTypes()

Description copied from interface: ClassTypeContainer

Returns the class types locally defined within this container. Returns inner types when this container is a class type.

Specified by:

getTypes in interface ClassTypeContainer

Returns:

a list of contained class types.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getFullSignature

public java.lang.String getFullSignature()

Description copied from interface: Type

Returns a full type signature of this type, i.e., the full name plus possible type arguments. Works as getFullName() on primitive types.

Specified by:

getFullSignature in interface Type

getErasedType

public ErasedType getErasedType()

Specified by:

getErasedType in interface ClassType

isInner

public boolean isInner()

Description copied from interface: ClassType

Checks if this type is an inner class, as described in JLS, 3rd edition, §8.1.3

Specified by:

isInner in interface ClassType

Returns: