com.helger.jcodemodel

Class JTypeVar

java.lang.Object

com.helger.jcodemodel.AbstractJType

com.helger.jcodemodel.AbstractJClass

com.helger.jcodemodel.JTypeVar

All Implemented Interfaces:

IJDeclaration, IJGenerable, IJOwned

Direct Known Subclasses:

JTypeVarClass

public class JTypeVar
extends AbstractJClass
implements IJDeclaration

Type variable used to declare generics.

Author:

Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)

See Also:

IJGenerifiable

Field Summary

Fields inherited from class com.helger.jcodemodel.AbstractJClass

EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JTypeVar(JCodeModel aOwner, String sName)

Method Summary

Methods

Modifier and Type	Method and Description
AbstractJClass	_extends() Returns the class bound of this variable.
Iterator<AbstractJClass>	_implements() Returns the interface bounds of this variable.
JPackage	_package() Gets the package to which this class belongs.
JTypeVar	bound(AbstractJClass bound) Adds a bound to this variable.
void	declare(JFormatter f) Prints out the declaration of the variable.
String	fullName() Gets the full name of the type.
void	generate(JFormatter f)
boolean	isAbstract()
boolean	isInterface()
String	name() Gets the name of this class.
protected AbstractJClass	substituteParams(JTypeVar[] variables, List<? extends AbstractJClass> bindings) Substitutes the type variables with their actual arguments.

Methods inherited from class com.helger.jcodemodel.AbstractJClass

array, boxify, dotclass, erasure, getBaseClass, getBaseClass, getPrimitiveType, getTypeParameters, isParameterized, narrow, narrow, narrow, narrow, narrow, narrow, outer, owner, staticInvoke, staticInvoke, staticRef, staticRef, toString, typeParams, unboxify, wildcard, wildcard, wildcardSuper

Methods inherited from class com.helger.jcodemodel.AbstractJType

binaryName, elementType, isArray, isAssignableFrom, isAssignableFrom, isError, isPrimitive, isReference, parse

Methods inherited from class java.lang.Object

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

Constructor Detail

JTypeVar

protected JTypeVar(@Nonnull
        JCodeModel aOwner,
        @Nonnull
        String sName)

Method Detail

name

@Nonnull
public String name()

Description copied from class: AbstractJClass

Gets the name of this class.

Specified by:

name in class AbstractJClass

Returns:

name of this class, without any qualification. For example, this method returns "String" for java.lang.String.

fullName

@Nonnull
public String fullName()

Description copied from class: AbstractJType

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.

Specified by:

fullName in class AbstractJType

Returns:

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

_package

@Nullable
public JPackage _package()

Description copied from class: AbstractJClass

Gets the package to which this class belongs. TODO: shall we move move this down?

Specified by:

_package in class AbstractJClass

Returns:

The JPackage this class belongs to. Is usually not null except for the JTypeVar and the JTypeWildcard implementation.

bound

@Nonnull
public JTypeVar bound(@Nonnull
                     AbstractJClass bound)

Adds a bound to this variable.

Parameters:

bound - Bound class to be added

Returns:

this

_extends

@Nonnull
public AbstractJClass _extends()

Returns the class bound of this variable.

If no bound is given, this method returns Object.

Specified by:

_extends in class AbstractJClass

Returns:

Returns the AbstractJClass representing the superclass of the entity (class or interface) represented by this AbstractJClass. Even if no super class is given explicitly or this AbstractJClass is not a class, this method still returns AbstractJClass for Object. If this AbstractJClass represents Object, return null.

_implements

@Nonnull
public Iterator<AbstractJClass> _implements()

Returns the interface bounds of this variable.

Specified by:

_implements in class AbstractJClass

Returns:

A non-null valid iterator that iterates all AbstractJClass objects that represents those interfaces implemented by this object.

isInterface

public boolean isInterface()

Specified by:

isInterface in class AbstractJClass

Returns:

true if this object represents an interface.

isAbstract

public boolean isAbstract()

Specified by:

isAbstract in class AbstractJClass

Returns:

true if this class is an abstract class.

substituteParams

@Nonnull
protected AbstractJClass substituteParams(@Nonnull
                                      JTypeVar[] variables,
                                      @Nonnull
                                      List<? extends AbstractJClass> bindings)

Description copied from class: AbstractJClass

Substitutes the type variables with their actual arguments.
For example, when this class is Map<String,Map<V>>, (where V then doing substituteParams( V, Integer ) returns a AbstractJClass for Map<String,Map<Integer>>.
This method needs to work recursively.

Specified by:

substituteParams in class AbstractJClass

Parameters:

variables - Type variables

bindings - Bindings

Returns:

Never null.

declare

public void declare(@Nonnull
           JFormatter f)

Prints out the declaration of the variable.

Specified by:

declare in interface IJDeclaration

generate

public void generate(@Nonnull
            JFormatter f)

Specified by:

generate in interface IJGenerable

Overrides:

generate in class AbstractJClass