com.helger.jcodemodel

Class AbstractJType

java.lang.Object

com.helger.jcodemodel.AbstractJType

All Implemented Interfaces:

IJGenerable, IJOwned

Direct Known Subclasses:

AbstractJClass, JPrimitiveType

public abstract class AbstractJType
extends Object
implements IJGenerable, IJOwned

A representation of a type in codeModel. A type is always either primitive ( JPrimitiveType) or a reference type (AbstractJClass).
Note: up to version 2.7.6 this class implemented Comparable <AbstractJType>. Since this was specific to import handling on emitting code, it was removed with 2.7.7!

Constructor Summary

Constructors

Constructor and Description
AbstractJType()

Method Summary

Modifier and Type	Method and Description
abstract JArrayClass	array() Create an array type of this type.
String	binaryName() Gets the binary name of the type.
abstract AbstractJClass	boxify() If this class is a primitive type, return the boxed class.
boolean	containsTypeVar(JTypeVar aVar) Check if this class is a generic class and contains the passed type variable.
AbstractJType	declarable()
AbstractJType	elementType() If this is an array, returns the component type of the array (T of T[]).
AbstractJType	erasure()
abstract String	fullName() Gets the full name of the type.
boolean	isArray() Tell whether or not this is an array type.
boolean	isAssignableFrom(AbstractJType that) Checks the relationship between two types.
protected boolean	isAssignableFrom(AbstractJType that, boolean bAllowsRawTypeUnchekedConversion)
boolean	isError() Tells whether or not this is an error-type.
boolean	isPrimitive() Tell whether or not this is a built-in primitive type, such as int or void.
boolean	isReference()
abstract String	name() Gets the name of this type.
static JPrimitiveType	parse(JCodeModel codeModel, String sTypeName) Obtains a reference to the primitive type object from a type name.
String	toString()
abstract AbstractJType	unboxify() If this class is a wrapper type for a primitive, return the primitive type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.jcodemodel.IJGenerable

generate

Methods inherited from interface com.helger.jcodemodel.IJOwned

owner

Constructor Detail

AbstractJType

public AbstractJType()

Method Detail

parse

@Nonnull
public static JPrimitiveType parse(@Nonnull
                                             JCodeModel codeModel,
                                             @Nonnull
                                             String sTypeName)

Obtains a reference to the primitive type object from a type name.

Parameters:

codeModel - Base code model

sTypeName - primitive type to be parsed (e.g. "int" or "void")

Returns:

Never null

Throws:

IllegalArgumentException - If the passed type name is not a primitive type name

fullName

@Nullable
public abstract String fullName()

Gets the full name of the type. See http://java.sun.com/docs/books/jls/second_edition/html/names.doc.html#25430 for the details.

Returns:

Strings like "int", "java.lang.String", "java.io.File[]". May be null for unnamed classes.

binaryName

@Nonnull
public String binaryName()

Gets the binary name of the type. See http://java.sun.com/docs/books/jls/third_edition/html/binaryComp.html#44909

Returns:

Name like "Foo$Bar", "int", "java.lang.String", "java.io.File[]". Never null.

name

@Nonnull
public abstract String name()

Gets the name of this type.

Returns:

Names like "int", "void", "BigInteger".

array

public abstract JArrayClass array()

Create an array type of this type. This method is undefined for primitive void type, which doesn't have any corresponding array representation.

Returns:

A JArrayClass representing the array type whose element type is this type

isArray

public boolean isArray()

Tell whether or not this is an array type.

Returns:

true if this an array type

isPrimitive

public boolean isPrimitive()

Tell whether or not this is a built-in primitive type, such as int or void.

Returns:

true if this is a primitive type

isError

public boolean isError()

Tells whether or not this is an error-type.

Error types are not actual Java types and shouldn't be used in actually generated code.

Returns:

true if this is an error class

See Also:

JErrorClass

boxify

@Nonnull
public abstract AbstractJClass boxify()

If this class is a primitive type, return the boxed class. Otherwise return this.

For example, for "int", this method returns "java.lang.Integer".

Returns:

Never null

unboxify

@Nonnull
public abstract AbstractJType unboxify()

If this class is a wrapper type for a primitive, return the primitive type. Otherwise return this.

For example, for "java.lang.Integer", this method returns "int".

Returns:

Never null

erasure

@Nonnull
public AbstractJType erasure()

Returns:

the erasure of this type. This is only relevant for narrowed classes like List<Integer> in which case this method returns the reference to List without any generic type parameters.

declarable

@Nonnull
public AbstractJType declarable()

Returns:

type that can be used to declare method result or variable. This is only relevant for wildcards types that can't be used in such context in which case this method returns the bound of wildcard type.

isReference

public final boolean isReference()

Returns:

true if this is a referenced type (which means it is not a primitive type).

elementType

@Nonnull
public AbstractJType elementType()

If this is an array, returns the component type of the array (T of T[]). Important: call this method only if you check that this is an array type ( isArray()).

Returns:

Never null.

Throws:

IllegalArgumentException - If this is not an array type

containsTypeVar

public boolean containsTypeVar(@Nullable
                               JTypeVar aVar)

Check if this class is a generic class and contains the passed type variable.

Parameters:

aVar - The type variable to check. May be null.

Returns:

true if the passed type variable is contained, false otherwise.

isAssignableFrom

public boolean isAssignableFrom(@Nonnull
                                AbstractJType that)

Checks the relationship between two types.

This method performs superset of actions that are performed by Class.isAssignableFrom(Class) For example, baseClass.isAssignableFrom(derivedClass) is always true.

There are two differences of this method and Class.isAssignableFrom(Class)

1. This method works with primitive types
2. This method processes generic arguments and supports wildcards

Examples:

1. [[List]].isAssignableFrom ([[List<T>]])
2. [[List<T>]].isAssignableFrom ([[List]])
3. [[List<? extends Object>]].isAssignableFrom ([[List<Integer>]])
4. [[List<? super Serializable>]].isAssignableFrom ([[List<String>]])
5. [[List<? super Serializable>]].isAssignableFrom ([[List<String>]])
6. [[List<? extends Object>]].isAssignableFrom ([[List<? extends Integer>]])
7. [[List<? extends List<? extends Object>>]].isAssignableFrom ([[List<List<Integer>>]])

Parameters:

that - Type to check

Returns:

true if assignable, false if not

isAssignableFrom

protected boolean isAssignableFrom(@Nonnull
                                   AbstractJType that,
                                   boolean bAllowsRawTypeUnchekedConversion)

toString

public String toString()

Overrides:

toString in class Object