org.objectweb.speedo.generation.api
Class SpeedoCompilerParameter

java.lang.Object
  extended by org.objectweb.speedo.generation.api.SpeedoCompilerParameter

public class SpeedoCompilerParameter
extends java.lang.Object

This class groups all parameter of the Speedo generator/compiler/enhancer.

Author:
S.Chassande-Barrioz

Field Summary
 java.util.Collection awareFiles
          The list of .class file locations of the aware class.
 java.lang.String awareFilesDir
          The base directory of the location of .class of aware class
 org.apache.tools.ant.types.Path classpath
          the classpath to compile.
 java.util.ArrayList dtdLocations
          list of DTDLocation instance
 boolean generateNeededJormFile
          indicates if the .pd files must be generated
 java.util.Map generatorsContext
          Defines a map holding stuffs between component generators.
 java.lang.String input
          The default source directory
 org.apache.tools.ant.taskdefs.Javac javac
          The compiler to use
 java.util.Collection jorm
          The list of .pd file locations.
 java.util.Collection jormclasspath
           
 java.lang.String jormDir
          The base directory of the location of .pd file
 boolean keepsrc
          indicates if the generated java file must be kept or not
 org.objectweb.util.monolog.api.LoggerFactory loggerFactory
          The logger factory instance
 java.lang.String logPropFile
          The logging configuration file
 java.lang.String mapperName
          The jorm mapper name.
 NamingManagerFactory nmf
          The NamingManagerFactory instance to use.
 java.lang.String output
          the location of the user .class files the location where the generated files will be produced
 java.lang.String pdoutput
          The output directory of the .pd files
 Personality personality
           
 java.lang.String projectName
          The jorm project name.
 SpeedoMetaInfo smi
          The Speedo meta information
 org.apache.tools.ant.types.Path speedoclasspath
           
 java.util.Collection xml
          The list of .jdo file locations.
 java.lang.String xmlDir
          The base directory of the location of xml file (persistent descriptor)
 
Constructor Summary
SpeedoCompilerParameter()
           
 
Method Summary
 void clean()
          Clean this parameter holder.
 java.util.Map getXmldescriptor()
           
 void setXmldescriptor(java.util.Map xmldescriptor)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

logPropFile

public java.lang.String logPropFile
The logging configuration file


loggerFactory

public org.objectweb.util.monolog.api.LoggerFactory loggerFactory
The logger factory instance


projectName

public java.lang.String projectName
The jorm project name. The default value is an empty string (not nul)


mapperName

public java.lang.String mapperName
The jorm mapper name. The default value is null. This field MUST be set


keepsrc

public boolean keepsrc
indicates if the generated java file must be kept or not


output

public java.lang.String output
the location of the user .class files the location where the generated files will be produced


input

public java.lang.String input
The default source directory


jormclasspath

public java.util.Collection jormclasspath

speedoclasspath

public org.apache.tools.ant.types.Path speedoclasspath

generateNeededJormFile

public boolean generateNeededJormFile
indicates if the .pd files must be generated


pdoutput

public java.lang.String pdoutput
The output directory of the .pd files


smi

public SpeedoMetaInfo smi
The Speedo meta information


classpath

public org.apache.tools.ant.types.Path classpath
the classpath to compile. must include Jorm, Speedo, user classes.


xml

public java.util.Collection xml
The list of .jdo file locations. The location is relative to the value of the 'jdoDir' variable.


xmlDir

public java.lang.String xmlDir
The base directory of the location of xml file (persistent descriptor)


jorm

public java.util.Collection jorm
The list of .pd file locations. The location is relative to the value of the 'jormDir' variable.


jormDir

public java.lang.String jormDir
The base directory of the location of .pd file


awareFiles

public java.util.Collection awareFiles
The list of .class file locations of the aware class. The location is relative to the value of the 'jormDir' variable.


awareFilesDir

public java.lang.String awareFilesDir
The base directory of the location of .class of aware class


dtdLocations

public java.util.ArrayList dtdLocations
list of DTDLocation instance


javac

public org.apache.tools.ant.taskdefs.Javac javac
The compiler to use


nmf

public NamingManagerFactory nmf
The NamingManagerFactory instance to use. It permits to build the jorm meta information.


generatorsContext

public final java.util.Map generatorsContext
Defines a map holding stuffs between component generators.


personality

public Personality personality
Constructor Detail

SpeedoCompilerParameter

public SpeedoCompilerParameter()
Method Detail

getXmldescriptor

public java.util.Map getXmldescriptor()

setXmldescriptor

public void setXmldescriptor(java.util.Map xmldescriptor)

clean

public void clean()
Clean this parameter holder.