|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.enhydra.zeus.generator.SimpleGenerator
is the portion of Zeus that will convert
a set of constraints, visible through a Generator
,
and output them as generated Java classes (to a
Binding
File
[directory]).
SimpleGenerator
is the simplest form of a
Generator
and takes in either a single Binding
or a List
of them, and directly generates Java classes.
Field Summary | |
protected java.lang.String |
collectionClass
The Collection class to use |
protected boolean |
generateAsSerializable
This determines if the class should be serializable |
protected java.util.List |
ignoredBindings
A list of bindings to ignore |
protected java.io.File |
implDir
Directory where all generated implementation classes should be placed. |
protected java.lang.String |
implPackage
The package name for the implementation classes. |
protected boolean |
initialized
Keeps track of whether the Generator needs to be reinitialized. |
protected java.io.File |
interfaceDir
Directory where all generated interfaces should be placed. |
protected java.lang.String |
interfacePackage
The package name of the interface/implementation classes |
protected java.lang.String |
javaPackage
The package name of the interface/implementation classes |
protected java.io.File |
outputDir
Base directory for generated files. |
Fields inherited from interface org.enhydra.zeus.Generator |
DEFAULT_COLLECTION_CLASS |
Constructor Summary | |
SimpleGenerator()
This will construct a new instance of SimpleGenerator . |
Method Summary | |
void |
generate(Binding binding)
This will convert from a set of constraints to Java classes. |
boolean |
generateAsSerializable()
This will return true if the generator is set to
generate Serializable classes, or else
false . |
java.lang.String |
getCollectionClass()
This will return the current class used for Collection
properties. |
java.lang.String |
getImplementationPackage()
Returns the Java package to generate implementation classes within. |
java.lang.String |
getInterfacePackage()
Returns the Java package to generate interfaces within. |
void |
setCollectionClass(java.lang.String collectionClass)
This will set the Collection class to use anytime that
a collection of values need to be stored. |
void |
setGenerateAsSerializable(boolean generateAsSerializable)
This will allow for setting the generator to generate serializable classes. |
void |
setIgnoreBinding(java.lang.String bindingName)
This allows a binding to be ignored. |
void |
setImplementationPackage(java.lang.String implPackage)
Sets the Java package to generate new interfaces within. |
void |
setInterfacePackage(java.lang.String interfacePackage)
Sets the Java package to generate new interfaces within. |
void |
setJavaPackage(java.lang.String javaPackage)
Sets the Java package to generate new interfaces and implementation within. |
void |
setOutputDirectory(java.io.File outputDir)
This sets the output directory to output generated classes to. |
void |
setOutputDirectory(java.lang.String outputDir)
This sets the output directory to output generated classes to. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected java.lang.String collectionClass
Collection
class to useprotected java.lang.String javaPackage
protected boolean generateAsSerializable
protected java.util.List ignoredBindings
protected java.lang.String interfacePackage
protected java.lang.String implPackage
protected java.io.File interfaceDir
protected java.io.File implDir
protected java.io.File outputDir
protected boolean initialized
Constructor Detail |
public SimpleGenerator()
This will construct a new instance of SimpleGenerator
.
Method Detail |
public void setCollectionClass(java.lang.String collectionClass)
This will set the Collection
class to use anytime that
a collection of values need to be stored. The default value for
this class is stored in
.
The class specified should be an implementation of the
Generator.DEFAULT_COLLECTION_CLASS
java.util.Collection
interface.
Note that the supplied class name must be fully qualified. For
example, java.util.List
would be fine, but
List
would not be.
setCollectionClass
in interface Generator
collectionClass
- String
name of collection to use.public java.lang.String getCollectionClass()
This will return the current class used for Collection
properties.
getCollectionClass
in interface Generator
String
- name of class used for Collection
s.public void setJavaPackage(java.lang.String javaPackage)
Sets the Java package to generate new interfaces and implementation within. For example, supplying the value com.foo.bar to this method and then generating classes, the classes would all be in the com.foo.bar package after generation.
setJavaPackage
in interface Generator
javaPackage
- String
the Java package to
generate interfaces and implementation classes within.public java.lang.String getInterfacePackage()
Returns the Java package to generate interfaces within.
getInterfacePackage
in interface Generator
String
- the Java package to unmarshall
interfaces to.public void setInterfacePackage(java.lang.String interfacePackage)
Sets the Java package to generate new interfaces within. For example, supplying the value com.foo.bar to this method and then generating classes, the interfaces would all be in the com.foo.bar package after generation.
setInterfacePackage
in interface Generator
interfacePackage
- String
the Java package to
generate interfaces within.public java.lang.String getImplementationPackage()
Returns the Java package to generate implementation classes within.
getImplementationPackage
in interface Generator
String
- the Java package to generate
implementation classes within.public void setImplementationPackage(java.lang.String implPackage)
Sets the Java package to generate new interfaces within. For example, supplying the value com.foo.bar to this method and then generating classes, the interfafces would all be in the com.foo.bar package after generation.
setImplementationPackage
in interface Generator
implPackage
- String
the Java package to
generate interfaces within.public void setOutputDirectory(java.lang.String outputDir)
This sets the output directory to output generated classes to.
setOutputDirectory
in interface Generator
baseDir
- the name of the base directory where
all generated classes should be placedpublic void setOutputDirectory(java.io.File outputDir)
This sets the output directory to output generated classes to.
setOutputDirectory
in interface Generator
outputDir
- the File
(directory) where
all generated classes should be placedpublic boolean generateAsSerializable()
This will return true
if the generator is set to
generate Serializable
classes, or else
false
.
generateAsSerializable
in interface Generator
boolean
- whether classes will be serializable.public void setGenerateAsSerializable(boolean generateAsSerializable)
This will allow for setting the generator to generate serializable classes. By default, classes are not set to be serializable.
setGenerateAsSerializable
in interface Generator
generateAsSerializable
- whether or not to generate serializable
classespublic void setIgnoreBinding(java.lang.String bindingName)
This allows a binding to be ignored. This is an intermediary step towards allowing binding schemas. The name of the binding should be passed in here, and no property generation for it will occur.
setIgnoreBinding
in interface Generator
bindingName
- the name of the binding to ignore.public void generate(Binding binding) throws java.io.IOException
This will convert from a set of constraints to Java classes.
It accesses those constraints through the
interface, which provides
them in a representation-independent format, and then
converts them into Java code.
Binding
generate
in interface Generator
binder
- Binder
with ability to convert from
constraints to Zeus Binding
s.IOException
- - when errors in writing to the
supplied Result
occur.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |