Class JJDocGlobals

  • Direct Known Subclasses:
    JJDoc, JJDocMain

    public class JJDocGlobals
    extends java.lang.Object
    Global variables for JJDoc.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static Generator generator
      The Generator to create output with.
      static java.lang.String input_file
      The name of the input file.
      static java.lang.String output_file
      The name of the output file.
    • Constructor Summary

      Constructors 
      Constructor Description
      JJDocGlobals()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void error​(JJDocContext context, java.lang.String message)
      Log error messages.
      static Generator getGenerator​(JJDocContext context)
      The commandline option is either TEXT or not, but the generator might have been set to some other Generator using the setGenerator method.
      static void info​(JJDocContext context, java.lang.String message)
      Log informational messages.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • input_file

        public static java.lang.String input_file
        The name of the input file.
      • output_file

        public static java.lang.String output_file
        The name of the output file.
      • generator

        public static Generator generator
        The Generator to create output with.
    • Constructor Detail

      • JJDocGlobals

        public JJDocGlobals()
    • Method Detail

      • getGenerator

        public static Generator getGenerator​(JJDocContext context)
        The commandline option is either TEXT or not, but the generator might have been set to some other Generator using the setGenerator method.
        Returns:
        the generator configured in options or set by setter.
      • info

        public static void info​(JJDocContext context,
                                java.lang.String message)
        Log informational messages.
        Parameters:
        message - the message to log
      • error

        public static void error​(JJDocContext context,
                                 java.lang.String message)
        Log error messages.
        Parameters:
        message - the message to log