org.sonar.java.resolve

Class JavaType

java.lang.Object

org.sonar.java.resolve.JavaType

All Implemented Interfaces:

Type

Direct Known Subclasses:

JavaType.ArrayJavaType, JavaType.ClassJavaType, JavaType.MethodJavaType, JavaType.TypeVariableJavaType, JavaType.WildCardType

public class JavaType
extends Object
implements Type

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavaType.ArrayJavaType
static class	JavaType.ClassJavaType
static class	JavaType.MethodJavaType
static class	JavaType.ParametrizedTypeJavaType
static class	JavaType.TypeVariableJavaType
static class	JavaType.UnknownType
static class	JavaType.WildCardType

Nested classes/interfaces inherited from interface org.sonar.plugins.java.api.semantic.Type

Type.ArrayType, Type.Primitives

Field Summary

Fields

Modifier and Type	Field and Description
static int	ARRAY
static int	BOOLEAN
static int	BOT
static int	BYTE
static int	CHAR
static int	CLASS
static int	DOUBLE
static int	FLOAT
static int	INT
static int	LONG
static int	METHOD
static int	SHORT
static int	TYPEVAR
static int	UNKNOWN
static int	VOID
static int	WILDCARD

Constructor Summary

Constructors

Constructor and Description
JavaType(int tag, JavaSymbol.TypeJavaSymbol symbol)

Method Summary

Methods

Modifier and Type	Method and Description
JavaType	erasure() JLS8 4.6
String	fullyQualifiedName() Fully qualified name of the type.
JavaSymbol.TypeJavaSymbol	getSymbol()
boolean	is(String fullyQualifiedName) Check whether a type is the one designed by the fully qualified name.
boolean	isArray() Check if this type is an array.
boolean	isClass() Check if this type is a class, an enum, an interface or an annotation.
boolean	isNumerical() Check if this type is a primitive numerical type.
boolean	isPrimitive() Check if this type is a primitive.
boolean	isPrimitive(Type.Primitives primitive) Check if this type is the given primitive.
boolean	isPrimitiveWrapper()
boolean	isSubtypeOf(String fullyQualifiedName) Check whether a type is a subtype of the one designed by the fully qualified name.
boolean	isSubtypeOf(Type superType) Check whether a type is a subtype of another.
boolean	isTagged(int tag)
boolean	isUnknown() Check if this type has been resolved.
boolean	isVoid() Check if type is Void type.
String	name() simple name of the type.
JavaType	primitiveType()
JavaType	primitiveWrapperType()
Symbol.TypeSymbol	symbol() Symbol of this type.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BYTE

public static final int BYTE

See Also:

Constant Field Values

CHAR

public static final int CHAR

See Also:

Constant Field Values

SHORT

public static final int SHORT

See Also:

Constant Field Values

INT

public static final int INT

See Also:

Constant Field Values

LONG

public static final int LONG

See Also:

Constant Field Values

FLOAT

public static final int FLOAT

See Also:

Constant Field Values

DOUBLE

public static final int DOUBLE

See Also:

Constant Field Values

BOOLEAN

public static final int BOOLEAN

See Also:

Constant Field Values

VOID

public static final int VOID

See Also:

Constant Field Values

CLASS

public static final int CLASS

See Also:

Constant Field Values

ARRAY

public static final int ARRAY

See Also:

Constant Field Values

METHOD

public static final int METHOD

See Also:

Constant Field Values

BOT

public static final int BOT

See Also:

Constant Field Values

UNKNOWN

public static final int UNKNOWN

See Also:

Constant Field Values

TYPEVAR

public static final int TYPEVAR

See Also:

Constant Field Values

WILDCARD

public static final int WILDCARD

See Also:

Constant Field Values

Constructor Detail

JavaType

public JavaType(int tag,
        JavaSymbol.TypeJavaSymbol symbol)

Method Detail

isTagged

public boolean isTagged(int tag)

isNumerical

public boolean isNumerical()

Description copied from interface: Type

Check if this type is a primitive numerical type.

Specified by:

isNumerical in interface Type

Returns:

true if type is byte, char, short, int, long, float or double.

getSymbol

public JavaSymbol.TypeJavaSymbol getSymbol()

is

public boolean is(String fullyQualifiedName)

Description copied from interface: Type

Check whether a type is the one designed by the fully qualified name.

   Type type;
   type.is("int");
   type.is("int[]");
   type.is("java.lang.String[]");
   type.is("java.lang.Object");

Specified by:

is in interface Type

Parameters:

fullyQualifiedName - fully qualified name to check. Use "[]" for arrays and the simple name for primitive type ("int", "byte"...).

Returns:

true if the type is the one looked for. false otherwise.

isSubtypeOf

public boolean isSubtypeOf(String fullyQualifiedName)

Description copied from interface: Type

Check whether a type is a subtype of the one designed by the fully qualified name.

This method will consider implemented interfaces as well as superclasses.

   Type type;
   type.isSubtypeOf("Object[]");
   type.isSubtypeOf("org.mypackage.MyClass");
   type.isSubtypeOf("org.mypackage.MyInterface");
   type.isSubtypeOf("java.lang.Object");

Specified by:

isSubtypeOf in interface Type

Parameters:

fullyQualifiedName - fully qualified name to check in the type hierarchy. Use "[]" for arrays.

Returns:

true if the type is the one passed in parameter or have this type in its hierarchy. false otherwise.

isSubtypeOf

public boolean isSubtypeOf(Type superType)

Description copied from interface: Type

Check whether a type is a subtype of another.

This method will consider implemented interfaces as well as superclasses.

   Type type, myOtherType;
   type.isSubtypeOf(myOtherType);

Specified by:

isSubtypeOf in interface Type

Parameters:

superType - instance of a potential superType.

Returns:

true if types are equivalent or if the one passed in parameter is in the hierarchy. false otherwise.

erasure

public JavaType erasure()

JLS8 4.6

Specified by:

erasure in interface Type

isPrimitive

public boolean isPrimitive()

Description copied from interface: Type

Check if this type is a primitive.

Specified by:

isPrimitive in interface Type

Returns:

true if this is a primitive type.

isPrimitive

public boolean isPrimitive(Type.Primitives primitive)

Description copied from interface: Type

Check if this type is the given primitive.

   Type type;
   type.isPrimitive(Primitives.INT);

Specified by:

isPrimitive in interface Type

Parameters:

primitive - primitive type to be checked with.

Returns:

true if this is the primitive type

isUnknown

public boolean isUnknown()

Description copied from interface: Type

Check if this type has been resolved. Type can be unknown in incomplete part of Semantic Analysis or when bytecode for a type is not provided and a method cannot be resolved.

Specified by:

isUnknown in interface Type

Returns:

true if type has not been resolved by semantic analysis.

isPrimitiveWrapper

public boolean isPrimitiveWrapper()

toString

public String toString()

Overrides:

toString in class Object

primitiveType

@Nullable
public JavaType primitiveType()

primitiveWrapperType

@Nullable
public JavaType primitiveWrapperType()

isArray

public boolean isArray()

Description copied from interface: Type

Check if this type is an array.

Specified by:

isArray in interface Type

Returns:

true if this is an array.

isClass

public boolean isClass()

Description copied from interface: Type

Check if this type is a class, an enum, an interface or an annotation.

Specified by:

isClass in interface Type

Returns:

true if this is a class, enum, interface or annotation.

isVoid

public boolean isVoid()

Description copied from interface: Type

Check if type is Void type. This is used to check type of method invocation expressions.

Specified by:

isVoid in interface Type

Returns:

true if the type is void.

fullyQualifiedName

public String fullyQualifiedName()

Description copied from interface: Type

Fully qualified name of the type.

Specified by:

fullyQualifiedName in interface Type

Returns:

complete name of type.

name

public String name()

Description copied from interface: Type

simple name of the type.

Specified by:

name in interface Type

Returns:

simple name of type.

symbol

public Symbol.TypeSymbol symbol()

Description copied from interface: Type

Symbol of this type.

Specified by:

symbol in interface Type

Returns:

the symbol declaring this type.