org.enhydra.zeus
Interface Generator

All Known Implementing Classes:

SimpleGenerator

public interface Generator

Generator is the portion of Zeus that will convert a set of constraints, visible through a Binding, and output them as generated Java classes (to a Result.

Version:

1.0

Author:

Brett McLaughlin

Field Summary

static java.lang.String

DEFAULT_COLLECTION_CLASS The default Collection class

Method Summary

void	generate(Binding binding, java.io.File directory) This will convert from a set of constraints to Java classes.
java.lang.String	getCollectionClass() This will return the current class used for Collection properties.
java.lang.String	getJavaPackage() Returns the Java package to unmarshall classes to.
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	setJavaPackage(java.lang.String javaPackage) Sets the Java package to generate new classes within.

Field Detail

DEFAULT_COLLECTION_CLASS

public static final java.lang.String DEFAULT_COLLECTION_CLASS

The default Collection class

Method Detail

generate

public void generate(Binding binding,
                     java.io.File directory)
              throws java.io.IOException

This will convert from a set of constraints to Java classes. It accesses those constraints through the Binding interface, which provides them in a representation-independent format, and then converts them into Java code, which is output to the supplied Result.

Parameters:

binder - Binder with ability to convert from constraints to Zeus Bindings.

directory - File to output generated classes to.

Throws:

IOException - - when errors in writing to the supplied Result occur.

setCollectionClass

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 DEFAULT_COLLECTION_CLASS. The class specified should be an implementation of the java.util.Collection interface.

Parameters:

collectionClass - String name of collection to use.

getCollectionClass

public java.lang.String getCollectionClass()

This will return the current class used for Collection properties.

Returns:

String - name of class used for Collections.

getJavaPackage

public java.lang.String getJavaPackage()

Returns the Java package to unmarshall classes to.

Returns:

String - the Java package to unmarshall to.

setJavaPackage

public void setJavaPackage(java.lang.String javaPackage)

Sets the Java package to generate new classes within. For example, supplying the value com.foo.bar to this method and then generating classes, those classes would all be in the com.foo.bar package after generation.

Parameters:

javaPackage - String the Java package to generate classes within.