javax.lang.model.type

Interface TypeMirror

Known Subinterfaces:
ArrayType, DeclaredType, ErrorType, ExecutableType, NoType, NullType, PrimitiveType, ReferenceType, TypeVariable, WildcardType

public interface TypeMirror

Represents a realised type in the Java programming language. For example, a TypeMirror may represent a primitive type, a declared type (classes and interfaces), an array type, a type variable or the null type. To complete the possible types, wildcard types are represented as is a pseudo-type to represent packages and void, and the signature and return types of executables (constructors, methods and initialisers).

To compare two instances, use the utility methods in Types as there is no guarantee that == will hold. To determine the subtype of TypeMirror, use getKind() or a visitor, as implementations may use the same class to implement multiple subinterfaces.

Since:
1.6

Method Summary

R accept(TypeVisitor visitor, P param)
Applies a visitor to this type.
boolean
equals(Object obj)
Obeys the general contract specified by equals(Object) but does not indicate that two types represent the same type.
TypeKind
getKind()
Returns the kind of this element.
int
hashCode()
Obeys the general contract of Object.hashCode().
String
toString()
Returns an informative representation of the type.

Method Details

R accept

public  R accept(TypeVisitor visitor,
                      P param)
Applies a visitor to this type.
Parameters:
visitor - the visitor to apply to the element.
param - the additional parameter to be sent to the visitor.
Returns:
the return value from the visitor.

equals

public boolean equals(Object obj)
Obeys the general contract specified by equals(Object) but does not indicate that two types represent the same type. For this, javax.lang.model.Types.isSameType(TypeMirror, TypeMirror) should be used and the result of this method and that method may differ.
Overrides:
equals in interface Object
Parameters:
obj - the object to compare.
Returns:
true if this and obj are equal.

getKind

public TypeKind getKind()
Returns the kind of this element.
Returns:
the kind of element.

hashCode

public int hashCode()
Obeys the general contract of Object.hashCode().
Overrides:
hashCode in interface Object
Returns:
a hash code for this element.

toString

public String toString()
Returns an informative representation of the type. If possible, the form used should be the same as that used if the type was to be represented in source code. Any type names embedded in the result should be qualified where possible.
Overrides:
toString in interface Object
Returns:
a textual representation of the type.

TypeMirror.java -- Represents a realised type. Copyright (C) 2012 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.