com.helger.jcodemodel

Class JErrorClass

java.lang.Object

com.helger.jcodemodel.AbstractJType

com.helger.jcodemodel.AbstractJClass

com.helger.jcodemodel.JErrorClass

All Implemented Interfaces:

IJGenerable, IJOwned

public class JErrorClass
extends AbstractJClass

A special AbstractJClass that represents an error class.

Error-types represents holes or placeholders that can't be filled. JErrorClass differs from JDirectClass class in that it should never be used in generated code. References to error-classes can be used in hidden class-models. Such classes should never be actually written but can be somehow used during code generation. Use JCodeModel#buildsErrorTypeRefs method to test if your generated Java-sources contains references to error-types.

You should probably always check generated code with JCodeModel#buildsErrorTypeRefs method if you use any error-types.

Most of JErrorClass methods throws JErrorClassUsedException unchecked exceptions. Be careful and use AbstractJType#isError method to check for error-types before actually using it's methods.

Author:

Victor Nazarov

See Also:

JCodeModel.buildsErrorTypeRefs(), JCodeModel.errorClass(String)

Field Summary

Fields inherited from class com.helger.jcodemodel.AbstractJClass

EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JErrorClass(JCodeModel _owner, String sMessage)

Method Summary

Methods

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.
String	fullName() Gets the full name of the type.
String	getMessage()
boolean	isAbstract()
boolean	isError() Tells whether or not this is an error-type.
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, generate, 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, isPrimitive, isReference, parse

Methods inherited from class java.lang.Object

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

Constructor Detail

JErrorClass

protected JErrorClass(@Nonnull
           JCodeModel _owner,
           @Nonnull
           String sMessage)

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

@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

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

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.

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

getMessage

@Nonnull
public String getMessage()

substituteParams

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