Class SingleClassGenerator

java.lang.Object
org.exolab.castor.builder.SingleClassGenerator
public final class SingleClassGenerator extends Object
Writes a single class (and any associated inner classes) to a file.
Version:
$Revision: 0000 $ $Date: $
Author:
Keith Visco - Main author., Arnaud Blandin - Contributions., Nathan Green - Contributions., Edward Kuns - Separated from SourceGenerator

  • Constructor Details

    • SingleClassGenerator

      public SingleClassGenerator(ConsoleDialog dialog, SourceGenerator sourceGenerator, String conflictStrategyType, 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 Details

    • setJClassPrinterType

      public void setJClassPrinterType(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(String destDir)
      Sets the destination directory.
      Parameters:
      destDir - the destination directory.

    • setResourceDestinationDirectory

      public void setResourceDestinationDirectory(String destinationDirectory)
      Sets the destination directory for generated resources.
      Parameters:
      destDir - the destination directory.

    • setLineSeparator

      public void setLineSeparator(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

    • setNameConflictStrategy

      public void setNameConflictStrategy(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.