com.helger.jcodemodel

Class JNarrowedClass

java.lang.Object

com.helger.jcodemodel.AbstractJType

com.helger.jcodemodel.AbstractJClass

com.helger.jcodemodel.JNarrowedClass

All Implemented Interfaces:

IJGenerable, IJOwned

public class JNarrowedClass
extends AbstractJClass

Represents X<Y>. TODO: consider separating the decl and the use.

Author:

Kohsuke Kawaguchi (kohsuke.kawaguchi@sun.com)

Field Summary

Fields inherited from class com.helger.jcodemodel.AbstractJClass

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
JNarrowedClass(AbstractJClass basis, AbstractJClass arg)
JNarrowedClass(AbstractJClass basis, List<? extends AbstractJClass> args)

Method Summary

Modifier and Type	Method and Description
AbstractJClass	_extends() Gets the super class of this class.
Iterator<AbstractJClass>	_implements() Iterates all super interfaces directly implemented by this class/interface.
JPackage	_package() Gets the package to which this class belongs.
AbstractJClass	basis()
String	binaryName() Gets the binary name of the type.
boolean	containsTypeVar(JTypeVar aVar) Check if this class is a generic class and contains the passed type variable.
boolean	equals(Object obj)
AbstractJClass	erasure()
String	fullName() Gets the full name of the type.
void	generate(JFormatter f)
List<? extends AbstractJClass>	getTypeParameters()
int	hashCode()
boolean	isAbstract()
boolean	isArray() Tell whether or not this is an array type.
boolean	isError() Tells whether or not this is an error-type.
boolean	isInterface()
String	name() Gets the name of this class.
JNarrowedClass	narrow(AbstractJClass... clazz)
JNarrowedClass	narrow(AbstractJClass clazz) "Narrows" a generic class to a concrete class by specifying a type argument.
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, getBaseClass, getBaseClass, getPrimitiveType, isParameterized, methodRef, narrow, narrow, narrow, narrow, narrowEmpty, outer, owner, staticInvoke, staticInvoke, staticRef, staticRef, toString, typeParams, unboxify, wildcard, wildcard, wildcardSuper

Methods inherited from class com.helger.jcodemodel.AbstractJType

declarable, elementType, isAssignableFrom, isAssignableFrom, isPrimitive, isReference, parse

Methods inherited from class java.lang.Object

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

Constructor Detail

JNarrowedClass

public JNarrowedClass(@Nonnull
                      AbstractJClass basis,
                      @Nonnull
                      AbstractJClass arg)

JNarrowedClass

public JNarrowedClass(@Nonnull
                      AbstractJClass basis,
                      @Nonnull
                      List<? extends AbstractJClass> args)

Method Detail

containsTypeVar

public boolean containsTypeVar(@Nullable
                               JTypeVar aVar)

Description copied from class: AbstractJType

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

Overrides:

containsTypeVar in class AbstractJType

Parameters:

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

Returns:

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

basis

@Nonnull
public AbstractJClass basis()

narrow

public JNarrowedClass narrow(@Nonnull
                             AbstractJClass clazz)

Description copied from class: AbstractJClass

"Narrows" a generic class to a concrete class by specifying a type argument.
.narrow(X) builds Set<X> from Set.

Overrides:

narrow in class AbstractJClass

Parameters:

clazz - class to narrow with

Returns:

Never null. Narrowed class.

narrow

public JNarrowedClass narrow(@Nonnull
                             AbstractJClass... clazz)

Overrides:

narrow in class AbstractJClass

name

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.

binaryName

public String binaryName()

Description copied from class: AbstractJType

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

Overrides:

binaryName in class AbstractJType

Returns:

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

generate

public void generate(JFormatter f)

Specified by:

generate in interface IJGenerable

Overrides:

generate in class AbstractJClass

_package

@Nonnull
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.

_extends

@Nullable
public AbstractJClass _extends()

Description copied from class: AbstractJClass

Gets the super class of this class.

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()

Description copied from class: AbstractJClass

Iterates all super interfaces directly implemented by this class/interface.

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.

erasure

@Nonnull
public AbstractJClass erasure()

Overrides:

erasure in class AbstractJClass

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.

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.

isArray

public boolean isArray()

Description copied from class: AbstractJType

Tell whether or not this is an array type.

Overrides:

isArray in class AbstractJType

Returns:

true if this an array type

isError

public boolean isError()

Description copied from class: AbstractJType

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.

Overrides:

isError in class AbstractJType

Returns:

true if this is an error class

See Also:

JErrorClass

getTypeParameters

public List<? extends AbstractJClass> getTypeParameters()

Overrides:

getTypeParameters in class AbstractJClass

Returns:

If this class is parameterized, the type parameters of the given index.

substituteParams

protected AbstractJClass substituteParams(JTypeVar[] variables,
                                          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.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object