Constructor Detail

• SingleClassGenerator

  public SingleClassGenerator​(ConsoleDialog dialog,
                              SourceGenerator sourceGenerator,
                              java.lang.String conflictStrategyType,
                              java.lang.String jClassPrinterType)

  Creates an instance of this class.

  Parameters:

  dialog - A ConsoleDialog instance

  sourceGenerator - A SourceGenerator instance

  conflictStrategyType - Type of the ClassNameCRStrategy instance to be used.

  jClassPrinterType - The string representation of the printer to be used,

Method Detail

• setJClassPrinterType

  public void setJClassPrinterType​(java.lang.String jclassPrinterType)

  Sets the type of the JClassPrinter instance to be used for JClass writing.

  Parameters:

  jclassPrinterType - The string identifier if the printer,

• setDestDir

  public void setDestDir​(java.lang.String destDir)

  Sets the destination directory.

  Parameters:

  destDir - the destination directory.

• setResourceDestinationDirectory

  public void setResourceDestinationDirectory​(java.lang.String destinationDirectory)

  Sets the destination directory for generated resources.

  Parameters:

  destDir - the destination directory.

• setLineSeparator

  public void setLineSeparator​(java.lang.String lineSeparator)

  Sets the line separator to use when printing the source code.

  Parameters:

  lineSeparator - the line separator to use when printing the source code. This method is useful if you are generating source on one platform, but will be compiling the source on a different platform. Note:This can be any string, so be careful. I recommend either using the default or using one of the following:

   windows systems use: "\r\n"
   unix systems use: "\n"
   mac systems use: "\r"
   

• setDescriptorCreation

  public void setDescriptorCreation​(boolean createDescriptors)

  Sets whether or not to create ClassDescriptors for the generated classes. By default, descriptors are generated.

  Parameters:

  createDescriptors - a boolean, when true indicates to generated ClassDescriptors

• setJdoDescriptorCreation

  public void setJdoDescriptorCreation​(boolean createJdoDescriptors)

  Sets whether or not to create JDOClassDescriptors for the generated classes. By default, descriptors are generated.

  Parameters:

  createJdoDescriptors - if true, JDOClassDescriptors are generated.

• setPromptForOverwrite

  public void setPromptForOverwrite​(boolean promptForOverwrite)

  Sets whether or not to prompt when we would otherwise overwrite an existing JClass. If set to false, then it is always OK to overwrite an existing class. If set to true, the user will be prompted.

  Parameters:

  promptForOverwrite - the new value

• processIfNotAlreadyProcessed

  boolean processIfNotAlreadyProcessed​(java.util.Enumeration<?> classKeys,
                                       SGStateInfo state)
                                throws java.io.IOException

  Processes the JClass mapped by the provided key unless the JClass has already been processed.

  Parameters:

  state - SourceGenerator state

  classKeys - Enumeration over a collection of keys to ClassInfos

  Returns:

  true if processing is allowed to continue, false if the SourceGenerator state is STOP_STATUS,

  Throws:

  java.io.IOException - If an already existing '.castor.cdr' file can not be loaded or found

• process

  boolean process​(JClass[] classes,
                  SGStateInfo state)
           throws java.io.IOException

  Processes the given JClasses, one by one, stopping if the SourceGenerator state indicates STOP after processing one class.

  Parameters:

  classes - Array of classes to process

  state - SourceGenerator state

  Returns:

  true if processing is allowed to continue, false if the SourceGenerator state is STOP_STATUS,

  Throws:

  java.io.IOException - If an already existing '.castor.cdr' file can not be loaded or found

• process

  boolean process​(JClass jClass,
                  SGStateInfo state)
           throws java.io.IOException

  Processes the given JClass by checking for class name conflicts, and if there are none, making the class as processed and then printing the class and, if appropriate, its class descriptors.

  If there is a class name conflict, at best the user stops the source generation and at worst the user continues, skipping this class.

  Parameters:

  jClass - the class to process

  state - SourceGenerator state

  Returns:

  true if processing is allowed to continue, false if the SourceGenerator state is STOP_STATUS,

  Throws:

  java.io.IOException - If an already existing '.castor.cdr' file can not be loaded or found

• setNameConflictStrategy

  public void setNameConflictStrategy​(java.lang.String nameConflictStrategy)

  Sets the desired ClassNameCRStrategy instance type to be used for name conflict resolution.

  Parameters:

  nameConflictStrategy - the desired ClassNameCRStrategy instance type

• getSourceGenerator

  public SourceGenerator getSourceGenerator()

  Returns the SourceGenerator instance that created this class.

  Returns:

  the SourceGenerator instance that created this class.