com.helger.jcodemodel

Interface IJClassContainer<CLASSTYPE extends IJClassContainer<CLASSTYPE>>

Type Parameters:

CLASSTYPE - Implementation type

All Superinterfaces:

IJOwned

All Known Implementing Classes:

AbstractJClassContainer, JAnonymousClass, JDefinedClass, JDirectClass, JPackage

public interface IJClassContainer<CLASSTYPE extends IJClassContainer<CLASSTYPE>>
extends IJOwned

The common aspect of a package and a class.

Author:

Philip Helger

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()
JPackage	getPackage()
boolean	isClass()
boolean	isPackage()
IJClassContainer<?>	parentContainer()

Methods inherited from interface com.helger.jcodemodel.IJOwned

owner

Method Detail

isClass

boolean isClass()

Returns:

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

See Also:

isPackage()

isPackage

boolean isPackage()

Returns:

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

See Also:

isClass()

parentContainer

IJClassContainer<?> parentContainer()

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

JPackage getPackage()

Returns:

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

_class

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

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

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

CLASSTYPE _class(@Nonnull
               String sName)
                                                     throws JClassAlreadyExistsException

Add a new public class to this class/package.

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

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

Add a new class to this package/class.

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

CLASSTYPE _interface(@Nonnull
                   String sName)
                                                         throws JClassAlreadyExistsException

Adds a public interface to this package.

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

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

Add an interface to this class/package.

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

CLASSTYPE _annotationTypeDeclaration(@Nonnull
                                   String sName)
                                                                         throws JClassAlreadyExistsException

Add an annotationType Declaration to this package

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

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

Add an annotationType Declaration to this package

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

CLASSTYPE _enum(@Nonnull
              String sName)
                                                    throws JClassAlreadyExistsException

Add a public enum to this package

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
CLASSTYPE _enum(int nMods,
                      @Nonnull
                      String sName)
                                                    throws JClassAlreadyExistsException

Add a enum to this package

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
Collection<CLASSTYPE> classes()

Returns:

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