com.helger.jcodemodel

Class JDefinedClass

java.lang.Object

com.helger.jcodemodel.AbstractJType

com.helger.jcodemodel.AbstractJClass

com.helger.jcodemodel.AbstractJClassContainer<JDefinedClass>

com.helger.jcodemodel.JDefinedClass

All Implemented Interfaces:

IJAnnotatable, IJClassContainer<JDefinedClass>, IJDeclaration, IJDocCommentable, IJGenerable, IJGenerifiable, IJOwned

Direct Known Subclasses:

JAnonymousClass

public class JDefinedClass
extends AbstractJClassContainer<JDefinedClass>
implements IJDeclaration, IJGenerifiable, IJAnnotatable, IJDocCommentable

A generated Java class/interface/enum/....

This class models a declaration, and since a declaration can be always used as a reference, it inherits AbstractJClass.

Where to go from here?

You'd want to generate fields and methods on a class. See method(int, AbstractJType, String) and field(int, AbstractJType, String).

Field Summary

Fields

Modifier and Type	Field and Description
Object	metadata Deprecated.

Fields inherited from class com.helger.jcodemodel.AbstractJClassContainer

m_aClasses

Fields inherited from class com.helger.jcodemodel.AbstractJClass

EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JDefinedClass(IJClassContainer<?> aParent, int nMods, String sName, EClassType eClassType)
protected	JDefinedClass(JCodeModel aOwner, int nMods, String sName) Constructor for creating anonymous inner class.

Method Summary

Methods

Modifier and Type	Method and Description
AbstractJClass	_extends() Returns the class extended by this class.
JDefinedClass	_extends(AbstractJClass aSuperClass) This class extends the specified class.
JDefinedClass	_extends(Class<?> superClass)
Iterator<AbstractJClass>	_implements() Returns an iterator that walks the nested classes defined in this class.
JDefinedClass	_implements(AbstractJClass iface) This class implements the specifed interface.
JDefinedClass	_implements(Class<?> iface)
JPackage	_package() Gets the package to which this class belongs.
JAnnotationUse	annotate(AbstractJClass clazz) Adds an annotation to this program element.
JAnnotationUse	annotate(Class<? extends Annotation> clazz) Adds an annotation to this program element.
<W extends IJAnnotationWriter<?>> W	annotate2(Class<W> clazz) Adds an annotation to this program element and returns a type-safe writer to fill in the values of such annotations.
Collection<JAnnotationUse>	annotations() Read-only live view of all annotations on this IJAnnotatable
String	binaryName() Gets the binary name of the type.
JMethod	constructor(int mods) Adds a constructor to this class.
Iterator<JMethod>	constructors()
boolean	containsField(String sName)
protected JDefinedClass	createInnerClass(int nMods, EClassType eClassType, String sName)
void	declare(JFormatter f)
protected void	declareBody(JFormatter f) prints the body of a class.
void	direct(String string) Places the given string directly inside the generated class.
JEnumConstant	enumConstant(String name) If the named enum already exists, the reference to it is returned.
JFieldVar	field(int mods, AbstractJType type, String name) Adds a field to the list of field members of this JDefinedClass.
JFieldVar	field(int mods, AbstractJType type, String name, IJExpression init) Adds a field to the list of field members of this JDefinedClass.
JFieldVar	field(int mods, Class<?> type, String name)
JFieldVar	field(int mods, Class<?> type, String name, IJExpression init)
Map<String,JFieldVar>	fields() Returns all the fields declared in this class.
JTypeVar	generify(String name) Adds a new type variable to this declaration.
JTypeVar	generify(String name, AbstractJClass bound) Adds a new type variable to this declaration with a bound.
JTypeVar	generify(String name, Class<?> bound) Adds a new type variable to this declaration with a bound.
JMethod	getConstructor(AbstractJType[] aArgTypes) Looks for a method that has the specified method signature and return it.
JMethod	getMethod(String sName, AbstractJType[] aArgTypes) Looks for a method that has the specified method signature and return it.
void	hide() Mark this file as hidden, so that this file won't be generated.
JBlock	init() Creates, if necessary, and returns the static initializer for this class.
JBlock	instanceInit() Creates, if necessary, and returns the instance initializer for this class.
boolean	isAbstract()
boolean	isHidden()
JDocComment	javadoc() Creates, if necessary, and returns the class javadoc for this JDefinedClass
JMethod	method(int mods, AbstractJType type, String name) Add a method to the list of method members of this JDefinedClass instance.
JMethod	method(int mods, Class<?> type, String name)
Collection<JMethod>	methods()
JMods	mods()
void	removeField(JFieldVar aField) Removes a JFieldVar from this class.
protected AbstractJClass	substituteParams(JTypeVar[] variables, List<? extends AbstractJClass> bindings) Substitutes the type variables with their actual arguments.
List<JTypeVar>	typeParamList() Get a list of all type parameters of this declaration.
JTypeVar[]	typeParams() Iterates all the type parameters of this class/interface.

Methods inherited from class com.helger.jcodemodel.AbstractJClassContainer

_annotationTypeDeclaration, _annotationTypeDeclaration, _class, _class, _class, _enum, _enum, _interface, _interface, classes, fullName, getClassType, getOuter, getPackage, isAnnotationTypeDeclaration, isAnonymous, isClass, isInterface, isPackage, name, outer, parentContainer, thisAsT

Methods inherited from class com.helger.jcodemodel.AbstractJClass

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

Methods inherited from class com.helger.jcodemodel.AbstractJType

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

Methods inherited from interface com.helger.jcodemodel.IJOwned

owner

Field Detail

metadata

@Deprecated
public Object metadata

Deprecated.

Client-app specific metadata associated with this user-created class.

Constructor Detail

JDefinedClass

protected JDefinedClass(@Nonnull
             IJClassContainer<?> aParent,
             int nMods,
             @Nullable
             String sName,
             @Nonnull
             EClassType eClassType)

JDefinedClass

protected JDefinedClass(@Nonnull
             JCodeModel aOwner,
             int nMods,
             @Nullable
             String sName)

Constructor for creating anonymous inner class.

Parameters:

aOwner - Owning code model

nMods - Java modifier

sName - Name of this class

Method Detail

_extends

@Nonnull
public JDefinedClass _extends(@Nonnull
                             AbstractJClass aSuperClass)

This class extends the specified class.

Parameters:

aSuperClass - Superclass for this class

Returns:

This class

_extends

@Nonnull
public JDefinedClass _extends(@Nonnull
                             Class<?> superClass)

_extends

@Nonnull
public AbstractJClass _extends()

Returns the class extended by 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 JDefinedClass _implements(@Nonnull
                                AbstractJClass iface)

This class implements the specifed interface.

Parameters:

iface - Interface that this class implements

Returns:

This class

_implements

@Nonnull
public JDefinedClass _implements(@Nonnull
                                Class<?> iface)

_implements

@Nonnull
public Iterator<AbstractJClass> _implements()

Returns an iterator that walks the nested classes defined in this class.

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.

enumConstant

@Nonnull
public JEnumConstant enumConstant(@Nonnull
                                 String name)

If the named enum already exists, the reference to it is returned. Otherwise this method generates a new enum reference with the given name and returns it.

Parameters:

name - The name of the constant.

Returns:

The generated type-safe enum constant.

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.

isAbstract

public boolean isAbstract()

Specified by:

isAbstract in class AbstractJClass

Returns:

true if this class is an abstract class.

field

public JFieldVar field(int mods,
              AbstractJType type,
              String name)

Adds a field to the list of field members of this JDefinedClass.

Parameters:

mods - Modifiers for this field

type - JType of this field

name - Name of this field

Returns:

Newly generated field

field

public JFieldVar field(int mods,
              Class<?> type,
              String name)

field

@Nonnull
public JFieldVar field(int mods,
                      @Nonnull
                      AbstractJType type,
                      @Nonnull
                      String name,
                      @Nullable
                      IJExpression init)

Adds a field to the list of field members of this JDefinedClass.

Parameters:

mods - Modifiers for this field.

type - JType of this field.

name - Name of this field.

init - Initial value of this field.

Returns:

Newly generated field

field

@Nonnull
public JFieldVar field(int mods,
                      Class<?> type,
                      String name,
                      IJExpression init)

fields

@Nonnull
public Map<String,JFieldVar> fields()

Returns all the fields declared in this class. The returned Map is a read-only live view.

Returns:

always non-null.

removeField

public void removeField(@Nonnull
               JFieldVar aField)

Removes a JFieldVar from this class.

Parameters:

aField - Field to be removed

Throws:

IllegalArgumentException - if the given field is not a field on this class.

containsField

public boolean containsField(@Nullable
                    String sName)

Parameters:

sName - Field name to check. May be null.

Returns:

true if such a field is contained, false otherwise.

init

@Nonnull
public JBlock init()

Creates, if necessary, and returns the static initializer for this class.

Returns:

JBlock containing initialization statements for this class

instanceInit

@Nonnull
public JBlock instanceInit()

Creates, if necessary, and returns the instance initializer for this class.

Returns:

JBlock containing initialization statements for this class

constructor

@Nonnull
public JMethod constructor(int mods)

Adds a constructor to this class.

Parameters:

mods - Modifiers for this constructor

Returns:

Newly created JMethod

constructors

@Nonnull
public Iterator<JMethod> constructors()

Returns:

an iterator that walks the constructors defined in this class.

getConstructor

@Nullable
public JMethod getConstructor(@Nonnull
                              AbstractJType[] aArgTypes)

Looks for a method that has the specified method signature and return it.

Parameters:

aArgTypes - Signature to search

Returns:

null if not found.

method

@Nonnull
public JMethod method(int mods,
                     AbstractJType type,
                     String name)

Add a method to the list of method members of this JDefinedClass instance.

Parameters:

mods - Modifiers for this method

type - Return type for this method

name - Name of the method

Returns:

Newly generated JMethod

method

@Nonnull
public JMethod method(int mods,
                     Class<?> type,
                     String name)

methods

@Nonnull
public Collection<JMethod> methods()

Returns:

the set of methods defined in this class.

getMethod

@Nullable
public JMethod getMethod(String sName,
                         AbstractJType[] aArgTypes)

Looks for a method that has the specified method signature and return it.

Parameters:

sName - Method name to search

aArgTypes - Signature to search

Returns:

null if not found.

javadoc

@Nonnull
public JDocComment javadoc()

Creates, if necessary, and returns the class javadoc for this JDefinedClass

Specified by:

javadoc in interface IJDocCommentable

Returns:

JDocComment containing javadocs for this class

hide

public void hide()

Mark this file as hidden, so that this file won't be generated.
This feature could be used to generate code that refers to class X, without actually generating X.java.

isHidden

public boolean isHidden()

declare

public void declare(@Nonnull
           JFormatter f)

Specified by:

declare in interface IJDeclaration

declareBody

protected void declareBody(@Nonnull
               JFormatter f)

prints the body of a class.

Parameters:

f - Formatter to use

direct

public void direct(@Nullable
          String string)

Places the given string directly inside the generated class. This method can be used to add methods/fields that are not generated by CodeModel. This method should be used only as the last resort.

Parameters:

string - Direct code block

_package

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

generify

@Nonnull
public JTypeVar generify(@Nonnull
                        String name)

Description copied from interface: IJGenerifiable

Adds a new type variable to this declaration.

Specified by:

generify in interface IJGenerifiable

Parameters:

name - type variable name

Returns:

The created JTypeVar

generify

@Nonnull
public JTypeVar generify(@Nonnull
                        String name,
                        @Nonnull
                        Class<?> bound)

Description copied from interface: IJGenerifiable

Adds a new type variable to this declaration with a bound.

Specified by:

generify in interface IJGenerifiable

Parameters:

name - type variable name

bound - Bound class

Returns:

The created JTypeVar

generify

@Nonnull
public JTypeVar generify(@Nonnull
                        String name,
                        @Nonnull
                        AbstractJClass bound)

Description copied from interface: IJGenerifiable

Adds a new type variable to this declaration with a bound.

Specified by:

generify in interface IJGenerifiable

Parameters:

name - type variable name

bound - Bound class

Returns:

The created JTypeVar

typeParams

@Nonnull
public JTypeVar[] typeParams()

Description copied from class: AbstractJClass

Iterates all the type parameters of this class/interface.
For example, if this AbstractJClass represents Set<T>, this method returns an array that contains single JTypeVar for 'T'.

Specified by:

typeParams in interface IJGenerifiable

Overrides:

typeParams in class AbstractJClass

Returns:

All type parameters as array.

typeParamList

@Nonnull
public List<JTypeVar> typeParamList()

Description copied from interface: IJGenerifiable

Get a list of all type parameters of this declaration.

Specified by:

typeParamList in interface IJGenerifiable

Returns:

All type parameters

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.

annotate

@Nonnull
public JAnnotationUse annotate(@Nonnull
                              Class<? extends Annotation> clazz)

Description copied from interface: IJAnnotatable

Adds an annotation to this program element.

Specified by:

annotate in interface IJAnnotatable

Parameters:

clazz - The annotation class to annotate the program element with

Returns:

Newly created JAnnotationUse

annotate

@Nonnull
public JAnnotationUse annotate(@Nonnull
                              AbstractJClass clazz)

Description copied from interface: IJAnnotatable

Adds an annotation to this program element.

Specified by:

annotate in interface IJAnnotatable

Parameters:

clazz - The annotation class to annotate the program element with

Returns:

Newly created JAnnotationUse

annotate2

@Nonnull
public <W extends IJAnnotationWriter<?>> W annotate2(@Nonnull
                                                    Class<W> clazz)

Description copied from interface: IJAnnotatable

Adds an annotation to this program element and returns a type-safe writer to fill in the values of such annotations.

Specified by:

annotate2 in interface IJAnnotatable

Type Parameters:

W - Implementation type

Parameters:

clazz - Source class

Returns:

Instance of the source class

annotations

@Nonnull
public Collection<JAnnotationUse> annotations()

Description copied from interface: IJAnnotatable

Read-only live view of all annotations on this IJAnnotatable

Specified by:

annotations in interface IJAnnotatable

Returns:

Can be empty but never null.

mods

@Nonnull
public JMods mods()

Returns:

the current modifiers of this class. Always return non-null valid object.

createInnerClass

@Nonnull
protected JDefinedClass createInnerClass(int nMods,
                                     EClassType eClassType,
                                     String sName)

Specified by:

createInnerClass in class AbstractJClassContainer<JDefinedClass>