com.helger.jcodemodel

Class AbstractJClassContainer<CLASSTYPE extends AbstractJClassContainer<CLASSTYPE>>

java.lang.Object

com.helger.jcodemodel.AbstractJType

com.helger.jcodemodel.AbstractJClass

com.helger.jcodemodel.AbstractJClassContainer<CLASSTYPE>

All Implemented Interfaces:

IJClassContainer<CLASSTYPE>, IJGenerable, IJOwned

Direct Known Subclasses:

JDefinedClass, JDirectClass

public abstract class AbstractJClassContainer<CLASSTYPE extends AbstractJClassContainer<CLASSTYPE>>
extends AbstractJClass
implements IJClassContainer<CLASSTYPE>

A generated Java class/interface/enum/annotation
This class models a declaration, and since a declaration can be always used as a reference, it inherits AbstractJClass.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,CLASSTYPE>	m_aClasses Nested classes as a map from name to JDefinedClass.

Fields inherited from class com.helger.jcodemodel.AbstractJClass

EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractJClassContainer(JCodeModel aOwner, IJClassContainer<?> aOuter, EClassType eClassType, String sName) JClass constructor

Method Summary

Methods

Modifier and Type	Method and Description
CLASSTYPE	_annotationTypeDeclaration(int nMods, String sName) Add an annotationType Declaration to this package
CLASSTYPE	_annotationTypeDeclaration(String sName) Add an annotationType Declaration to this package
CLASSTYPE	_class(int nMods, String sName) Add a new class to this package/class.
CLASSTYPE	_class(int nMods, String sName, EClassType eClassType) Creates a new class/enum/interface/annotation.
CLASSTYPE	_class(String sName) Add a new public class to this class/package.
CLASSTYPE	_enum(int nMods, String sName) Add a enum to this package
CLASSTYPE	_enum(String sName) Add a public enum to this package
CLASSTYPE	_interface(int nMods, String sName) Add an interface to this class/package.
CLASSTYPE	_interface(String sName) Adds a public interface to this package.
Collection<CLASSTYPE>	classes() Returns an iterator that walks the nested classes defined in this class.
protected abstract CLASSTYPE	createInnerClass(int nMods, EClassType eClassType, String sName)
String	fullName() Gets the fully qualified name of this class.
EClassType	getClassType()
IJClassContainer<?>	getOuter()
JPackage	getPackage()
boolean	isAnnotationTypeDeclaration() This method indicates if the interface is an annotationTypeDeclaration
boolean	isAnonymous()
boolean	isClass()
boolean	isInterface()
boolean	isPackage()
String	name() Class name accessor.
AbstractJClass	outer()
IJClassContainer<?>	parentContainer()
protected CLASSTYPE	thisAsT()

Methods inherited from class com.helger.jcodemodel.AbstractJClass

_extends, _implements, _package, array, boxify, dotclass, erasure, generate, getBaseClass, getBaseClass, getPrimitiveType, getTypeParameters, isAbstract, isParameterized, narrow, narrow, narrow, narrow, narrow, narrow, owner, staticInvoke, staticInvoke, staticRef, staticRef, substituteParams, 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

Methods inherited from interface com.helger.jcodemodel.IJOwned

owner

Field Detail

m_aClasses

protected Map<String,CLASSTYPE extends AbstractJClassContainer<CLASSTYPE>> m_aClasses

Nested classes as a map from name to JDefinedClass. The name is all capitalized in a case sensitive file system ( JCodeModel.isCaseSensitiveFileSystem) to avoid conflicts. Lazily created to save footprint.

See Also:

_getClasses()

Constructor Detail

AbstractJClassContainer

protected AbstractJClassContainer(@Nonnull
                       JCodeModel aOwner,
                       @Nullable
                       IJClassContainer<?> aOuter,
                       @Nonnull
                       EClassType eClassType,
                       @Nullable
                       String sName)

JClass constructor

Parameters:

aOwner - Owning code model

aOuter - Optional outer class container

eClassType - Class type to use

sName - Name of this class

Method Detail

getOuter

@Nullable
public final IJClassContainer<?> getOuter()

outer

@Nullable
public final AbstractJClass outer()

Overrides:

outer in class AbstractJClass

Returns:

the class in which this class is nested, or null if this is a top-level class.

getClassType

@Nonnull
public final EClassType getClassType()

isInterface

public final boolean isInterface()

Specified by:

isInterface in class AbstractJClass

Returns:

true if this object represents an interface.

isAnnotationTypeDeclaration

public final boolean isAnnotationTypeDeclaration()

This method indicates if the interface is an annotationTypeDeclaration

Returns:

true if this an annotation type declaration

name

@Nullable
public String name()

Class name accessor.
For example, for java.util.List, this method returns "List""

Specified by:

name in class AbstractJClass

Returns:

Name of this class

fullName

@Nullable
public String fullName()

Gets the fully qualified name of this class.

Specified by:

fullName in class AbstractJType

Returns:

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

isAnonymous

public final boolean isAnonymous()

Returns:

true if this is an anonymous class.

isClass

public final boolean isClass()

Specified by:

isClass in interface IJClassContainer<CLASSTYPE extends AbstractJClassContainer<CLASSTYPE>>

Returns:

true if the container is a class, false if it is a package

See Also:

IJClassContainer.isPackage()

isPackage

public final boolean isPackage()

Specified by:

isPackage in interface IJClassContainer<CLASSTYPE extends AbstractJClassContainer<CLASSTYPE>>

Returns:

true if the container is a package, false if it is a class.

See Also:

IJClassContainer.isClass()

thisAsT

@Nonnull
protected final CLASSTYPE thisAsT()

parentContainer

@Nonnull
public final IJClassContainer<?> parentContainer()

Specified by:

parentContainer in interface IJClassContainer<CLASSTYPE extends AbstractJClassContainer<CLASSTYPE>>

Returns:

Parent IJClassContainer. If this is a package, this method returns a parent package, or null if this package is the root package. If this is an outer-most class, this method returns a JPackage to which it belongs. If this is an inner class, this method returns the outer class.

getPackage

public final JPackage getPackage()

Specified by:

getPackage in interface IJClassContainer<CLASSTYPE extends AbstractJClassContainer<CLASSTYPE>>

Returns:

The nearest package parent. If this.isPackage(), then return this.

createInnerClass

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

_class

@Nonnull
public final CLASSTYPE _class(int nMods,
                       @Nonnull
                       String sName,
                       @Nonnull
                       EClassType eClassType)
                                                                  throws JClassAlreadyExistsException

Description copied from interface: IJClassContainer

Creates a new class/enum/interface/annotation. This is the most generic method.

Specified by:

_class in interface IJClassContainer<CLASSTYPE extends AbstractJClassContainer<CLASSTYPE>>

Parameters:

nMods - Modifiers for this ...

sName - Name of ... to be added to this package.

eClassType - The type of class to create. May not be null.

Returns:

The created ...

Throws:

JClassAlreadyExistsException - If another class/interface/... with the same name already exists

_class

@Nonnull
public final CLASSTYPE _class(@Nonnull
                       String sName)
                                                                  throws JClassAlreadyExistsException

Description copied from interface: IJClassContainer

Add a new public class to this class/package.

Specified by:

_class in interface IJClassContainer<CLASSTYPE extends AbstractJClassContainer<CLASSTYPE>>

Parameters:

sName - Name of class to be added to this package

Returns:

Newly generated class

Throws:

JClassAlreadyExistsException - If another class/interface/... with the same name already exists

_class

@Nonnull
public final CLASSTYPE _class(int nMods,
                       @Nonnull
                       String sName)
                                                                  throws JClassAlreadyExistsException

Description copied from interface: IJClassContainer

Add a new class to this package/class.

Specified by:

_class in interface IJClassContainer<CLASSTYPE extends AbstractJClassContainer<CLASSTYPE>>

Parameters:

nMods - Modifiers for this class declaration

sName - Name of class to be added to this package

Returns:

Newly generated class

Throws:

JClassAlreadyExistsException - If another class/interface/... with the same name already exists

_interface

@Nonnull
public final CLASSTYPE _interface(@Nonnull
                           String sName)
                                                                      throws JClassAlreadyExistsException

Description copied from interface: IJClassContainer

Adds a public interface to this package.

Specified by:

_interface in interface IJClassContainer<CLASSTYPE extends AbstractJClassContainer<CLASSTYPE>>

Parameters:

sName - Name of interface to be added to this package

Returns:

Newly generated interface

Throws:

JClassAlreadyExistsException - If another class/interface/... with the same name already exists

_interface

@Nonnull
public final CLASSTYPE _interface(int nMods,
                           @Nonnull
                           String sName)
                                                                      throws JClassAlreadyExistsException

Description copied from interface: IJClassContainer

Add an interface to this class/package.

Specified by:

_interface in interface IJClassContainer<CLASSTYPE extends AbstractJClassContainer<CLASSTYPE>>

Parameters:

nMods - Modifiers for this interface declaration

sName - Name of interface to be added to this package

Returns:

Newly generated interface

Throws:

JClassAlreadyExistsException - If another class/interface/... with the same name already exists

_annotationTypeDeclaration

@Nonnull
public final CLASSTYPE _annotationTypeDeclaration(@Nonnull
                                           String sName)
                                                                                      throws JClassAlreadyExistsException

Description copied from interface: IJClassContainer

Add an annotationType Declaration to this package

Specified by:

_annotationTypeDeclaration in interface IJClassContainer<CLASSTYPE extends AbstractJClassContainer<CLASSTYPE>>

Parameters:

sName - Name of the annotation Type declaration to be added to this package

Returns:

newly created Annotation Type Declaration

Throws:

JClassAlreadyExistsException - If another class/interface/... with the same name already exists

_annotationTypeDeclaration

@Nonnull
public final CLASSTYPE _annotationTypeDeclaration(int nMods,
                                           @Nonnull
                                           String sName)
                                                                                      throws JClassAlreadyExistsException

Description copied from interface: IJClassContainer

Add an annotationType Declaration to this package

Specified by:

_annotationTypeDeclaration in interface IJClassContainer<CLASSTYPE extends AbstractJClassContainer<CLASSTYPE>>

Parameters:

nMods - Modifiers for this annotation Type declaration

sName - Name of the annotation Type declaration to be added to this package

Returns:

newly created Annotation Type Declaration

Throws:

JClassAlreadyExistsException - If another class/interface/... with the same name already exists

_enum

@Nonnull
public final CLASSTYPE _enum(@Nonnull
                      String sName)
                                                                 throws JClassAlreadyExistsException

Description copied from interface: IJClassContainer

Add a public enum to this package

Specified by:

_enum in interface IJClassContainer<CLASSTYPE extends AbstractJClassContainer<CLASSTYPE>>

Parameters:

sName - Name of the enum to be added to this package

Returns:

newly created enum

Throws:

JClassAlreadyExistsException - If another class/interface/... with the same name already exists

_enum

@Nonnull
public final CLASSTYPE _enum(int nMods,
                      @Nonnull
                      String sName)
                                                                 throws JClassAlreadyExistsException

Description copied from interface: IJClassContainer

Add a enum to this package

Specified by:

_enum in interface IJClassContainer<CLASSTYPE extends AbstractJClassContainer<CLASSTYPE>>

Parameters:

nMods - Modifiers for this enum declaration

sName - Name of the enum to be added to this package

Returns:

newly created Enum

Throws:

JClassAlreadyExistsException - If another class/interface/... with the same name already exists

classes

@Nonnull
public final Collection<CLASSTYPE> classes()

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

Specified by:

classes in interface IJClassContainer<CLASSTYPE extends AbstractJClassContainer<CLASSTYPE>>

Returns:

A collection with all nested classes defined in this class. Never null.