Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.exolab.castor.builder.util.ClassInfoResolverImpl
org.exolab.castor.builder.SGStateInfo
(package private) class SGStateInfo
extends ClassInfoResolverImpl
Field Summary | |
static int |
|
static int |
|
protected String |
|
Constructor Summary | |
|
Method Summary | |
void |
|
Properties |
|
Enumeration |
|
(package private) FactoryState |
|
(package private) Dialog |
|
JClass |
|
Map |
|
MappingRoot |
|
Enumeration |
|
(package private) JClass |
|
(package private) Schema |
|
JClass |
|
JClass[] |
|
(package private) SourceGenerator |
|
Map |
|
int |
|
(package private) boolean |
|
(package private) void |
|
(package private) boolean |
|
(package private) boolean | |
(package private) boolean |
|
void |
|
(package private) void |
|
(package private) void | |
void |
|
(package private) void |
|
(package private) void |
|
(package private) void |
|
(package private) void |
|
void |
|
(package private) boolean |
|
Methods inherited from class org.exolab.castor.builder.util.ClassInfoResolverImpl | |
bindReference , keys , resolve |
public static final int NORMAL_STATUS
The SourceGenerator is still generating source
- Field Value:
- 0
public static final int STOP_STATUS
The SourceGenerator has been stopped by an error or by the user
- Field Value:
- 1
protected String _packageName
The package used when creating new classes.
protected SGStateInfo(Schema schema, SourceGenerator sgen)
Creates a new SGStateInfo
- Parameters:
schema
- the Schema to generate source forsgen
- the SourceGenerator instance
public void bindSourceCode(Annotated annotated, JClass[] classes)
Binds the given Annotated structure with its generated source classes.
- Parameters:
annotated
- the Annotated structure to add JClass bindings forclasses
- the JClass[] to bind
public Properties getCDRFile(String filename)
Returns the CDRFile (Properties file) associated with the given filename.
- Parameters:
filename
- filename of the CDR file to be processed
- Returns:
- the Properties file.
public Enumeration getCDRFilenames()
Returns the set of CDR file names.
- Returns:
- the set of CDR file names.
(package private) FactoryState getCurrentFactoryState()
Returns the current FactoryState that holds information about the classes being generated.
- Returns:
- the current FactoryState
(package private) Dialog getDialog()
Returns the Dialog used for interacting with the user.
- Returns:
- the Dialog, or null if none has been set.
public JClass getImportedSourceCode(String className)
Returns the JClass with the given name or null if no bindings have been specified for a JClass with the name. This method consults with JClass instances imported through a Schema import only.
- Parameters:
className
- the name of the JClass
- Returns:
- the (imported) JClass if found
public Map getImportedSourcesByName()
Returns the sources as generated through XML schema imports.
- Returns:
- the sources as generated through XML schema imports.
public MappingRoot getMapping(String filename)
Returns the Mapping file associated with the given filename.
- Parameters:
filename
- The filename to search for a Mapping File association
- Returns:
- the Mapping file.
public Enumeration getMappingFilenames()
Returns the set of mapping filenames.
- Returns:
- the set of mapping filenames.
(package private) JClass getProcessed(String className)
Returns the processed JClass with the given name. If no such JClass has been marked as processed, null is returned.
- Parameters:
className
- the JClass name to check against
- Returns:
- the JClass with the given name
(package private) Schema getSchema()
Returns a reference to the schema for which we are generating source.
- Returns:
- a reference to the schema for which we are generating source.
public JClass getSourceCode(String className)
Returns the JClass with the given name or null if no bindings have been specified for a JClass with the name.
- Parameters:
className
- the name of the JClass
- Returns:
- the JClass if found
public JClass[] getSourceCode(Annotated annotated)
Returns the array of JClass for the given Annotated structure or null if no bindings have been specified for the given Structure.
- Parameters:
annotated
- the Annotated structure to search
- Returns:
- the JClass array
(package private) SourceGenerator getSourceGenerator()
Returns the SourceGenerator instance being used.
- Returns:
- the SourceGenerator instance being used.
public Map getSourcesByName()
Returns the sources as generated through XML schema imports.
- Returns:
- the sources as generated through XML schema imports.
public int getStatusCode()
Returns the current status.
- Returns:
- the current status.
(package private) boolean getSuppressNonFatalWarnings()
Returns true if non-fatal warnings should be suppressed.
- Returns:
- true if non-fatal warnings should be suppressed.
(package private) void markAsProcessed(JClass jClass)
Marks the given JClass as having been processed.
- Parameters:
jClass
- the JClass to mark as having been processed.
(package private) boolean processed(String className)
Returns true if a JClass with the given name has been marked as processed
- Parameters:
className
- the JClass name to check against
- Returns:
- true if a JClass with the given name has been marked as processed
(package private) boolean processed(JClass jClass)
Returns true if the given JClass has been marked as processed.
- Parameters:
jClass
- the JClass to check for being marked as processed
- Returns:
- true if the given JClass has been marked as processed.
(package private) boolean promptForOverwrite()
Returns true if existing source files should be prompted before being overwritten
- Returns:
- true if existing source files should be prompted before being overwritten
public void setCDRFile(String filename, Properties props)
Sets the CDR (ClassDescriptorResolver) file associated with the given filename.
- Parameters:
filename
- the filename associated with the CDR fileprops
- the Properties file
(package private) void setCurrentFactoryState(FactoryState state)
Sets the current FactoryState.
- Parameters:
state
- the current FactoryState
- See Also:
getCurrentFactoryState()
(package private) void setDialog(Dialog dialog)
Sets the Dialog used for interacting with the user.
- Parameters:
dialog
- the Dialog to use
public void setMapping(String filename, MappingRoot mapping)
Sets the Mapping file associated with the given filename.
- Parameters:
filename
- the filename associated with the Mappingmapping
- the MappingRoot
(package private) void setPromptForOverwrite(boolean promptForOverwrite)
Sets whether or not existing source files should be silently overwritten or whether the user should be prompted first.
- Parameters:
promptForOverwrite
- true if existing files should not be silently overwritten.
(package private) void setStatusCode(int status)
Sets the current status code to the given one.
- Parameters:
status
- the new status code
(package private) void setSuppressNonFatalWarnings(boolean suppressNonFatalWarnings)
Sets whether non-fatal warnings should be supporessed
- Parameters:
suppressNonFatalWarnings
- true if non-fatal warnings should be supporessed
(package private) void setVerbose(boolean verbose)
Sets whether or not the source code generator prints additional messages during generating source code.
- Parameters:
verbose
- a boolean, when true indicates to print additional messages
public void storeImportedSourcesByName(Map importedSourcesByName)
Stores generated sources as processed within an imported schema.
- Parameters:
importedSourcesByName
- Generated sources as processed within an imported schema.
(package private) boolean verbose()
Returns the value of the verbose flag. A true value indicates that additional messages may be printed during processing.
- Returns:
- the value of the verbose flag.