Class DescriptionGenerator


  • public final class DescriptionGenerator
    extends Object
    A utility application for generating class descriptions.
    • Constructor Detail

      • DescriptionGenerator

        public DescriptionGenerator()
    • Method Detail

      • main

        public static void main​(String[] args)
                         throws Exception
        Runs the generator, using the 'generator.properties' file for configuration info.
        Parameters:
        args - command line arguments.
        Throws:
        Exception - if something goes wrong!
      • generate

        public static DescriptionModel generate​(String source,
                                                Properties configuration,
                                                DescriptionModel model)
        Generates a DescriptionModel from the specified source.
        Parameters:
        source - the source directory.
        configuration - the configuration properties.
        model - the model (null permitted).
        Returns:
        A class description model.
      • writeSingleFile

        public static void writeSingleFile​(String target,
                                           DescriptionModel model)
                                    throws IOException
        Writes the class description model to a single file.
        Parameters:
        target - the target file name.
        model - the class description model.
        Throws:
        IOException - if there is an I/O problem.
      • writeMultiFile

        public static void writeMultiFile​(String target,
                                          DescriptionModel model)
                                   throws IOException
        Writes the class description model to multiple files.
        Parameters:
        target - the target file name.
        model - the class description model.
        Throws:
        IOException - if there is an I/O problem.