Class Driver


  • public class Driver
    extends java.lang.Object
    Command Line Interface of XJC.
    • Constructor Summary

      Constructors 
      Constructor Description
      Driver()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String getBuildID()  
      static void main​(java.lang.String[] args)  
      static int run​(java.lang.String[] args, XJCListener listener)
      Performs schema compilation and prints the status/error into the specified PrintStream.
      static int run​(java.lang.String[] args, java.io.PrintStream status, java.io.PrintStream out)
      Performs schema compilation and prints the status/error into the specified PrintStream.
      static void usage​(Options opts, boolean privateUsage)
      Prints the usage screen and exits the process.
      • Methods inherited from class java.lang.Object

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

      • Driver

        public Driver()
    • Method Detail

      • main

        public static void main​(java.lang.String[] args)
                         throws java.lang.Exception
        Throws:
        java.lang.Exception
      • run

        public static int run​(java.lang.String[] args,
                              java.io.PrintStream status,
                              java.io.PrintStream out)
                       throws java.lang.Exception
        Performs schema compilation and prints the status/error into the specified PrintStream.

        This method could be used to trigger XJC from other tools, such as Ant or IDE.

        Parameters:
        args - specified command line parameters. If there is an error in the parameters, BadCommandLineException will be thrown.
        status - Status report of the compilation will be sent to this object. Useful to update users so that they will know something is happening. Only ignorable messages should be sent to this stream. This parameter can be null to suppress messages.
        out - Various non-ignorable output (error messages, etc) will go to this stream.
        Returns:
        If the compiler runs successfully, this method returns 0. All non-zero values indicate an error. The error message will be sent to the specified PrintStream.
        Throws:
        java.lang.Exception
      • run

        public static int run​(java.lang.String[] args,
                              @NotNull
                              XJCListener listener)
                       throws BadCommandLineException
        Performs schema compilation and prints the status/error into the specified PrintStream.

        This method could be used to trigger XJC from other tools, such as Ant or IDE.

        Parameters:
        args - specified command line parameters. If there is an error in the parameters, BadCommandLineException will be thrown.
        listener - Receives messages from XJC reporting progress/errors.
        Returns:
        If the compiler runs successfully, this method returns 0. All non-zero values indicate an error. The error message will be sent to the specified PrintStream.
        Throws:
        BadCommandLineException
      • getBuildID

        public static java.lang.String getBuildID()
      • usage

        public static void usage​(@Nullable
                                 Options opts,
                                 boolean privateUsage)
        Prints the usage screen and exits the process.
        Parameters:
        opts - If the parsing of options have started, set a partly populated Options object.