WLRmic (Apache Ant API)
Date: 2016-04-09

org.apache.tools.ant.taskdefs.rmic

## Class WLRmic

- java.lang.Object
- - org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter
  - - org.apache.tools.ant.taskdefs.rmic.WLRmic

- All Implemented Interfaces:
    RmicAdapter

      public class WLRmic
      extends DefaultRmicAdapter

  The implementation of the rmic for WebLogic
  Since:
    Ant 1.4

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static java.lang.String` | `COMPILER_NAME` the name of this adapter for users to select
    `static java.lang.String` | `ERROR_NO_WLRMIC_ON_CLASSPATH` The error string to use if not able to find the weblogic rmic
    `static java.lang.String` | `ERROR_WLRMIC_FAILED` The error string to use if not able to start the weblogic rmic
    `static java.lang.String` | `UNSUPPORTED_STUB_OPTION` unsupported error message
    `static java.lang.String` | `WL_RMI_SKEL_SUFFIX` The skeleton suffix
    `static java.lang.String` | `WL_RMI_STUB_SUFFIX` The stub suffix
    `static java.lang.String` | `WLRMIC_CLASSNAME` The classname of the weblogic rmic

    - ### Fields inherited from class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter

      `RMI_SKEL_SUFFIX, RMI_STUB_SUFFIX, RMI_TIE_SUFFIX, STUB_1_1, STUB_1_2, STUB_COMPAT, STUB_OPTION_1_1, STUB_OPTION_1_2, STUB_OPTION_COMPAT`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `WLRmic()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected java.lang.String` | `addStubVersionOptions()` This is an override point; no stub version is returned.
    `boolean` | `execute()` Carry out the rmic compilation.
    `java.lang.String` | `getSkelClassSuffix()` Get the suffix for the rmic skeleton classes
    `java.lang.String` | `getStubClassSuffix()` Get the suffix for the rmic stub classes
    `protected java.lang.String[]` | `preprocessCompilerArgs(java.lang.String[] compilerArgs)` Strip out all -J args from the command list.

    - ### Methods inherited from class org.apache.tools.ant.taskdefs.rmic.DefaultRmicAdapter

      `filterJvmCompilerArgs, getClasspath, getCompileClasspath, getMapper, getRmic, getTieClassSuffix, logAndAddFilesToCompile, setRmic, setupRmicCommand, setupRmicCommand`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Field Detail

    - #### WLRMIC_CLASSNAME

          public static final java.lang.String WLRMIC_CLASSNAME

      The classname of the weblogic rmic
      See Also:
        Constant Field Values

    - #### COMPILER_NAME

          public static final java.lang.String COMPILER_NAME

      the name of this adapter for users to select
      See Also:
        Constant Field Values

    - #### ERROR_NO_WLRMIC_ON_CLASSPATH

          public static final java.lang.String ERROR_NO_WLRMIC_ON_CLASSPATH

      The error string to use if not able to find the weblogic rmic
      See Also:
        Constant Field Values

    - #### ERROR_WLRMIC_FAILED

          public static final java.lang.String ERROR_WLRMIC_FAILED

      The error string to use if not able to start the weblogic rmic
      See Also:
        Constant Field Values

    - #### WL_RMI_STUB_SUFFIX

          public static final java.lang.String WL_RMI_STUB_SUFFIX

      The stub suffix
      See Also:
        Constant Field Values

    - #### WL_RMI_SKEL_SUFFIX

          public static final java.lang.String WL_RMI_SKEL_SUFFIX

      The skeleton suffix
      See Also:
        Constant Field Values

    - #### UNSUPPORTED_STUB_OPTION

          public static final java.lang.String UNSUPPORTED_STUB_OPTION

      unsupported error message
      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### WLRmic

          public WLRmic()

  - ### Method Detail

    - #### execute

          public boolean execute()
                          throws BuildException

      Carry out the rmic compilation.
      Returns:
        true if the compilation succeeded
      Throws:
        `BuildException` - on error

    - #### getStubClassSuffix

          public java.lang.String getStubClassSuffix()

      Get the suffix for the rmic stub classes
      Overrides:
        `getStubClassSuffix` in class `DefaultRmicAdapter`
      Returns:
        the stub suffix

    - #### getSkelClassSuffix

          public java.lang.String getSkelClassSuffix()

      Get the suffix for the rmic skeleton classes
      Overrides:
        `getSkelClassSuffix` in class `DefaultRmicAdapter`
      Returns:
        the skeleton suffix

    - #### preprocessCompilerArgs

          protected java.lang.String[] preprocessCompilerArgs(java.lang.String[] compilerArgs)

      Strip out all -J args from the command list.
      Overrides:
        `preprocessCompilerArgs` in class `DefaultRmicAdapter`
      Parameters:
        `compilerArgs` - the original compiler arguments
      Returns:
        the filtered set.

    - #### addStubVersionOptions

          protected java.lang.String addStubVersionOptions()

      This is an override point; no stub version is returned. If any stub option is set, a warning is printed.
      Overrides:
        `addStubVersionOptions` in class `DefaultRmicAdapter`
      Returns:
        null, for no stub version