Package org.apache.axis.utils

Class CLOption

java.lang.Object
org.apache.axis.utils.CLOption
public final class CLOption extends Object
Basic class describing an instance of option.
Since:
4.0
Author:
Peter Donald

  • Field Details

    • TEXT_ARGUMENT

      public static final int TEXT_ARGUMENT
      Value of getId() when the option is a text argument.
      See Also:

  • Constructor Details

    • CLOption

      public CLOption(int id)
      Constructor taking an id (that must be a proper character code)
      Parameters:
      id - the new id

    • CLOption

      public CLOption(String argument)
      Constructor taking argument for option.
      Parameters:
      argument - the argument

  • Method Details

    • getArgument

      public final String getArgument()
      Retrieve argument to option if it takes arguments.
      Returns:
      the (first) argument

    • getArgument

      public final String getArgument(int index)
      Retrieve indexed argument to option if it takes arguments.
      Parameters:
      index - The argument index, from 0 to getArgumentCount()-1.
      Returns:
      the argument

    • getId

      public final int getId()
      Retrieve id of option. The id is eqivalent to character code if it can be a single letter option.
      Returns:
      the id

    • addArgument

      public final void addArgument(String argument)
      Mutator of Argument property.
      Parameters:
      argument - the argument

    • getArgumentCount

      public final int getArgumentCount()
      Get number of arguments.

    • toString

      public final String toString()
      Convert to String.
      Overrides:
      toString in class Object
      Returns:
      the string value