com.helger.jcodemodel

Class JPackage

java.lang.Object

com.helger.jcodemodel.JPackage

All Implemented Interfaces:

IJAnnotatable, IJClassContainer<JDefinedClass>, IJDeclaration, IJDocCommentable, IJGenerable, IJOwned, Comparable<JPackage>

public class JPackage
extends Object
implements IJDeclaration, IJGenerable, IJClassContainer<JDefinedClass>, IJAnnotatable, Comparable<JPackage>, IJDocCommentable

A Java package.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JPackage(String sName, JCodeModel aOwner) JPackage constructor

Method Summary

Methods

Modifier and Type	Method and Description
JDefinedClass	_annotationTypeDeclaration(int mods, String name) Add a annotationType Declaration to this package
JDefinedClass	_annotationTypeDeclaration(String name) Add a public annotationType Declaration to this package
JDefinedClass	_class(int nMods, String sName) Add a class to this package.
JDefinedClass	_class(int nMods, String sName, EClassType eClassType) Creates a new class/enum/interface/annotation.
JDefinedClass	_class(String sName) Adds a public class to this package.
JDefinedClass	_enum(int mods, String name) Add a enum to this package
JDefinedClass	_enum(String name) Add a public enum to this package
JDefinedClass	_getClass(String sName) Gets a reference to the already created JDefinedClass.
JDefinedClass	_interface(int nMods, String sName) Add an interface to this package.
JDefinedClass	_interface(String sName) Adds a public interface to this package.
AbstractJResourceFile	addResourceFile(AbstractJResourceFile rsrc) Adds a new resource file to this package.
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
Collection<JDefinedClass>	classes()
int	compareTo(JPackage aOther) Order is based on the lexicographic order of the package name.
void	declare(JFormatter f)
void	generate(JFormatter f)
JPackage	getPackage()
boolean	hasResourceFile(String name) Checks if a resource of the given name exists.
boolean	isClass()
boolean	isDefined(String classLocalName) Checks if a given name is already defined as a class/interface
boolean	isPackage()
boolean	isUnnamed() Checks if this package is the root, unnamed package.
JDocComment	javadoc() Creates, if necessary, and returns the package javadoc for this JDefinedClass.
String	name() Get the name of this package
JCodeModel	owner() Gets the owner code model object.
JPackage	parent()
IJClassContainer<?>	parentContainer()
Iterator<AbstractJResourceFile>	propertyFiles() Iterates all resource files in this package.
AbstractJClass	ref(String sClassLocalName) Reference a class within this package.
void	remove(AbstractJClass c) Removes a class from this package.
JPackage	subPackage(String sSubPackageName) Gets a reference to a sub package of this package.

Methods inherited from class java.lang.Object

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

Constructor Detail

JPackage

protected JPackage(@Nonnull
        String sName,
        @Nonnull
        JCodeModel aOwner)

JPackage constructor

Parameters:

sName - Name of package. May not be null but empty.

aOwner - The code writer being used to create this package

Throws:

IllegalArgumentException - If each part of the package name is not a valid identifier

Method Detail

parentContainer

@Nullable
public IJClassContainer<?> parentContainer()

Specified by:

parentContainer in interface IJClassContainer<JDefinedClass>

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.

parent

@Nullable
public JPackage parent()

Returns:

the parent package, or null if this class is the root package.

isClass

public boolean isClass()

Specified by:

isClass in interface IJClassContainer<JDefinedClass>

Returns:

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

See Also:

IJClassContainer.isPackage()

isPackage

public boolean isPackage()

Specified by:

isPackage in interface IJClassContainer<JDefinedClass>

Returns:

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

See Also:

IJClassContainer.isClass()

getPackage

@Nonnull
public JPackage getPackage()

Specified by:

getPackage in interface IJClassContainer<JDefinedClass>

Returns:

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

_class

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

Add a class to this package.

Specified by:

_class in interface IJClassContainer<JDefinedClass>

Parameters:

nMods - Modifiers for this class declaration

sName - Name of class to be added to this package

Returns:

Newly generated class

Throws:

JClassAlreadyExistsException - When the specified class/interface was already created.

_class

@Nonnull
public JDefinedClass _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<JDefinedClass>

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 JDefinedClass _class(@Nonnull
                           String sName)
                     throws JClassAlreadyExistsException

Adds a public class to this package.

Specified by:

_class in interface IJClassContainer<JDefinedClass>

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

_getClass

@Nullable
public JDefinedClass _getClass(@Nullable
                               String sName)

Gets a reference to the already created JDefinedClass.

Parameters:

sName - Class name to search

Returns:

null if the class is not yet created.

compareTo

public int compareTo(@Nonnull
            JPackage aOther)

Order is based on the lexicographic order of the package name.

Specified by:

compareTo in interface Comparable<JPackage>

Parameters:

aOther - Other package to compare to

_interface

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

Add an interface to this package.

Specified by:

_interface in interface IJClassContainer<JDefinedClass>

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

_interface

@Nonnull
public JDefinedClass _interface(@Nonnull
                               String sName)
                         throws JClassAlreadyExistsException

Adds a public interface to this package.

Specified by:

_interface in interface IJClassContainer<JDefinedClass>

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

_annotationTypeDeclaration

@Nonnull
public JDefinedClass _annotationTypeDeclaration(int mods,
                                               @Nonnull
                                               String name)
                                         throws JClassAlreadyExistsException

Add a annotationType Declaration to this package

Specified by:

_annotationTypeDeclaration in interface IJClassContainer<JDefinedClass>

Parameters:

mods - Modifiers for this annotationType declaration

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

Returns:

newly created Annotation Type Declaration

Throws:

JClassAlreadyExistsException - When the specified class/interface was already created.

_annotationTypeDeclaration

@Nonnull
public JDefinedClass _annotationTypeDeclaration(@Nonnull
                                               String name)
                                         throws JClassAlreadyExistsException

Add a public annotationType Declaration to this package

Specified by:

_annotationTypeDeclaration in interface IJClassContainer<JDefinedClass>

Parameters:

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

Returns:

newly created Annotation Type Declaration

Throws:

JClassAlreadyExistsException - When the specified class/interface was already created.

_enum

@Nonnull
public JDefinedClass _enum(int mods,
                          @Nonnull
                          String name)
                    throws JClassAlreadyExistsException

Add a enum to this package

Specified by:

_enum in interface IJClassContainer<JDefinedClass>

Parameters:

mods - Modifiers for this enum declaration

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

Returns:

newly created Enum

Throws:

JClassAlreadyExistsException - When the specified class/interface was already created.

_enum

@Nonnull
public JDefinedClass _enum(@Nonnull
                          String name)
                    throws JClassAlreadyExistsException

Add a public enum to this package

Specified by:

_enum in interface IJClassContainer<JDefinedClass>

Parameters:

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

Returns:

newly created Enum

Throws:

JClassAlreadyExistsException - When the specified class/interface was already created.

addResourceFile

@Nonnull
public AbstractJResourceFile addResourceFile(@Nonnull
                                            AbstractJResourceFile rsrc)

Adds a new resource file to this package.

Parameters:

rsrc - Resource file to add

Returns:

Parameter resource file

hasResourceFile

public boolean hasResourceFile(@Nullable
                      String name)

Checks if a resource of the given name exists.

Parameters:

name - Filename to check

Returns:

true if contained

propertyFiles

@Nonnull
public Iterator<AbstractJResourceFile> propertyFiles()

Iterates all resource files in this package.

Returns:

Iterator

javadoc

@Nonnull
public JDocComment javadoc()

Creates, if necessary, and returns the package javadoc for this JDefinedClass.

Specified by:

javadoc in interface IJDocCommentable

Returns:

JDocComment containing javadocs for this class

remove

public void remove(@Nonnull
          AbstractJClass c)

Removes a class from this package.

Parameters:

c - Class to be removed

ref

@Nonnull
public AbstractJClass ref(@Nonnull
                         String sClassLocalName)
                   throws ClassNotFoundException

Reference a class within this package.

Parameters:

sClassLocalName - Local class name to reference

Returns:

The referenced class

Throws:

ClassNotFoundException - If the provided class does not exist

subPackage

@Nonnull
public JPackage subPackage(@Nonnull
                          String sSubPackageName)

Gets a reference to a sub package of this package.

Parameters:

sSubPackageName - Name of the sub-package

Returns:

New sub-package

classes

@Nonnull
public Collection<JDefinedClass> classes()

Specified by:

classes in interface IJClassContainer<JDefinedClass>

Returns:

the top-level classes defined in this package.

isDefined

public boolean isDefined(@Nullable
                String classLocalName)

Checks if a given name is already defined as a class/interface

Parameters:

classLocalName - Class local name

Returns:

true if contained in this package

isUnnamed

public final boolean isUnnamed()

Checks if this package is the root, unnamed package.

Returns:

true if this is the root package

name

@Nonnull
public String name()

Get the name of this package

Returns:

The name of this package, or the empty string if this is the null package. For example, this method returns strings like "java.lang"

owner

@Nonnull
public final JCodeModel owner()

Description copied from interface: IJOwned

Gets the owner code model object.

Specified by:

owner in interface IJOwned

Returns:

the code model root object being used to create this package.

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

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

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.

declare

public void declare(@Nonnull
           JFormatter f)

Specified by:

declare in interface IJDeclaration

generate

public void generate(@Nonnull
            JFormatter f)

Specified by:

generate in interface IJGenerable