Using the Java Wrapper in Command-line Mode

This document covers the following topics:

See Using EntireX in the Designer Command-line Mode for the general command-line syntax.


Command-line Options

Note:
The commands -java:allbeancompliant, -java:tester and -java:clientbeancompliant commands will generate a Bean-compliant Java client. To generate client with inner classes (the old way) use -java:client or -java:all commands.

Task Command Option Description
Generate all Java source files for the specified IDL file(s). -java:all -clientpackage The client package name for the wrapper class.
-customclass A non-default superclass of the wrapper class.
-help Display this usage message.
-serverpackage The server package name for the server interface object class.
-sourcefolder The folder for the generated classes.
Generate the JavaBean-compliant Java client(s) for the specified IDL file(s). -java:allbeancompliant -clientpackage The client package name for the wrapper class.
-customclass A non-default superclass of the wrapper class.
-help Display this usage message.
-serverpackage The server package name for the server interface object class.
-sourcefolder The folder for the generated classes.
Generate the Java client(s) for the specified IDL file(s). -java:client -clientpackage The client package name for the wrapper class.
-customclass A non-default superclass of the wrapper class.
-help Display this usage message.
-public Generate a public wrapper class.
-sourcefolder The folder for the generated classes.
Generate the JavaBean-compliant Java client(s) for the specified IDL file(s). -java:clientbeancompliant -clientpackage The client package name for the wrapper class.
-customclass A non-default superclass of the wrapper class.
-help Display this usage message.
-public Generate a public wrapper class.
-sourcefolder The folder for the generated classes.
Generate the Java server(s) for the specified IDL file(s). -java:server -help Display this usage message.
-serverpackage The server package name for the server interface object class.
-sourcefolder The folder for the generated classes.
Generate the Java client(s) and tester(s) for the specified IDL file(s). -java:tester -clientpackage The client package name for the wrapper class.
-customclass A non-default superclass of the wrapper class.
-help Display this usage message.
-sourcefolder The folder for the generated classes.

Example

<workbench> -java:client /Demo/Example.idl -sourcefolder /Demo/src1 -clientpackage com.client

where <workbench> is a placeholder for the actual EntireX design-time starter as described under Using EntireX in the Designer Command-line Mode.

The name of the IDL file and the source folder include the project name. In the example, the project Demo is used. If the IDL file name describes a file inside the Eclipse workspace, the name is case-sensitive.

If the first part of the IDL file name is not a project name in the current workspace, the IDL file name is used as a file name in the file system. Thus, the IDL files do not need to be part of an Eclipse project.

If the source folder does not exist in the workspace but the first part describing the project exists, the source folder is created.

If the IDL file is located outside the Eclipse workspace, the source folder is also a folder in the file system.

Status and processing messages are written to standard output (stdout), which is normally set to the executing shell window.

Further Examples

Windows

  • Example 1:
    <workbench> -java:client C:\Temp\example.idl -sourcefolder src -clientpackage com.client

    Uses the IDL file at C:\Temp\example.idl and generates the Java source files to the subfolder src\com\client of the current working directory.

    Output to standard output:

    Using workspace file:/C:/myWorkspace/.
    Processing IDL file C:\Temp\example.idl
    Writing to file src/com/client/Example.java.
    Exit value: 0
  • Example 2:
    <workbench> -java:client C:\Temp\*idl -sourcefolder src -clientpackage com.client

    Generates Java clients for all IDL files in C:\Temp.

  • Example 3:
    <workbench> -java:client C:\Temp\example.idl -sourcefolder C:\Temp\src -clientpackage com.client

    Uses the IDL file at C:\Temp\example.idl and generates the Java source files to C:\Temp\src\com\client.

  • Example 4:
    <workbench> -java:client C:/Temp/example.idl -sourcefolder C:/Temp/src -clientpackage com.client

    The same as above. Both slashes and backslashes are permitted.

  • Example 5:
    <workbench> -java:client -help

    or

    <workbench> -help -java:client

    Both show a short help for the Java client wrapper.

Linux

  • Example 1:
    <workbench> -java:client /Demo/Example.idl -sourcefolder /Demo/src1 -clientpackage com.client

    If the project Demo exists in the workspace and Example.idl exists in this project, this file is used. Otherwise, /Demo/Example.idl is used from file system.

  • Example 2:
    <workbench> -java:client /Demo/*.idl -sourcefolder /Demo/src1 -clientpackage com.client

    Generates Java clients for all IDL files in project Demo (or in folder /Demo if the project does not exist). The generated files are in /Demo/src1/com/client.

  • Example 3:
    <workbench> -java:client -help

    or

    <workbench> -help -java:client

    Both show a short help for the Java client wrapper.