org.jibx.schema.codegen

Class PackageHolder

java.lang.Object

org.jibx.schema.codegen.PackageHolder

public class PackageHolder
extends Object

Information for a package to be included in code generated from schema.

Author:

Dennis M. Sosnoski

Constructor Summary

Constructors

Constructor and Description
PackageHolder(String name, File dir, PackageHolder parent) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
ClassHolder	addClass(String name, NameConverter nconv, ClassDecorator[] decorators, boolean inner, boolean enumer, BindingHolder holder) Add class to package.
ClassHolder	addClass(String name, String base, NameConverter nconv, ClassDecorator[] decorators, boolean enumer, BindingHolder holder) Add derived class to package.
void	addInnerClass(IClassHolder clas) Add an inner class to package.
void	generate(boolean verbose, org.eclipse.jdt.core.dom.AST ast, BindingOrganizer directory) Generate this package.
void	generate(boolean verbose, TypeData clasdata, org.eclipse.jdt.core.dom.AST ast) Generate a specific class within this package.
int	getClassCount() Get the total number of classes (including inner classes) in package.
StringObjectPair[]	getClassFields() Get the field information for every class in this package.
File	getGenerateDirectory() Get generate directory.
String	getName() Get fully-qualified package name.
PackageHolder	getParent() Get parent package.
int	getSubpackageCount() Get the number of subpackages created for this package.
int	getTopClassCount() Get the number of top-level classes in package.

Methods inherited from class java.lang.Object

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

Constructor Detail

PackageHolder

public PackageHolder(String name,
             File dir,
             PackageHolder parent)

Constructor.

Parameters:

name - full package name (dot-separated form)

dir - target directory for code generation (null if skipping code generation)

parent - parent package information

Method Detail

getGenerateDirectory

public File getGenerateDirectory()

Get generate directory.

Returns:

generate directory

getParent

public PackageHolder getParent()

Get parent package.

Returns:

parent package

getName

public String getName()

Get fully-qualified package name.

Returns:

name

getTopClassCount

public int getTopClassCount()

Get the number of top-level classes in package.

Returns:

count

getClassCount

public int getClassCount()

Get the total number of classes (including inner classes) in package.

Returns:

count

getSubpackageCount

public int getSubpackageCount()

Get the number of subpackages created for this package.

Returns:

count

addClass

public ClassHolder addClass(String name,
                   NameConverter nconv,
                   ClassDecorator[] decorators,
                   boolean inner,
                   boolean enumer,
                   BindingHolder holder)

Add class to package.

Parameters:

name - preferred name for class

nconv - name converter for class

decorators - class decorators

inner - use inner classes for substructures

enumer - enumeration class flag

holder - binding holder

Returns:

class generator

addClass

public ClassHolder addClass(String name,
                   String base,
                   NameConverter nconv,
                   ClassDecorator[] decorators,
                   boolean enumer,
                   BindingHolder holder)

Add derived class to package. This method is only used when top-level classes are being used for substructures.

Parameters:

name - preferred name for class

base - base class name

nconv - name converter for class

decorators - class decorators

enumer - enumeration class flag

holder - binding holder

Returns:

class generator

addInnerClass

public void addInnerClass(IClassHolder clas)

Add an inner class to package.

Parameters:

clas -

generate

public void generate(boolean verbose,
            TypeData clasdata,
            org.eclipse.jdt.core.dom.AST ast)

Generate a specific class within this package. This first tests if the class has already been generated, and if it has does nothing.

Parameters:

verbose -

clasdata - class data

ast -

generate

public void generate(boolean verbose,
            org.eclipse.jdt.core.dom.AST ast,
            BindingOrganizer directory)

Generate this package.

Parameters:

verbose -

ast -

directory - binding directory

getClassFields

public StringObjectPair[] getClassFields()

Get the field information for every class in this package. The returned pairs have the fully-qualified class name as the key, and the array of ordered field name and type string pairs as the values. This method is only meaningful after the class has been generated.

Returns:

class field information