org.apache.axis.utils

Class CLOptionDescriptor


public final class CLOptionDescriptor
extends java.lang.Object

Basic class describing an type of option. Typically, one creates a static array of CLOptionDescriptors, and passes it to CLArgsParser.CLArgsParser(String[],CLOptionDescriptor[]).
Author:
Peter Donald
Since:
4.0

Field Summary

static int
ARGUMENTS_REQUIRED_2
Flag to say this option requires 2 arguments
static int
ARGUMENT_DISALLOWED
Flag to say this option does not take arguments
static int
ARGUMENT_OPTIONAL
Flag to say that the argument is optional
static int
ARGUMENT_REQUIRED
Flag to say that one argument is required
static int
DUPLICATES_ALLOWED
Flag to say this option may be repeated on the command line

Constructor Summary

CLOptionDescriptor(String name, int flags, int id, String description)
Constructor.
CLOptionDescriptor(String name, int flags, int id, String description, int[] incompatable)
Constructor.

Method Summary

String
getDescription()
Retrieve textual description.
int
getFlags()
Retrieve flags about option.
int
getId()
Retrieve the id for option.
protected int[]
getIncompatble()
Deprecated. Use the correctly spelled getIncompatible() instead.
protected int[]
getIncompatible()
String
getName()
Retrieve name of option which is also text for long option.
String
toString()
Convert to String.

Field Details

ARGUMENTS_REQUIRED_2

public static final int ARGUMENTS_REQUIRED_2
Flag to say this option requires 2 arguments
Field Value:
16

ARGUMENT_DISALLOWED

public static final int ARGUMENT_DISALLOWED
Flag to say this option does not take arguments
Field Value:
8

ARGUMENT_OPTIONAL

public static final int ARGUMENT_OPTIONAL
Flag to say that the argument is optional
Field Value:
4

ARGUMENT_REQUIRED

public static final int ARGUMENT_REQUIRED
Flag to say that one argument is required
Field Value:
2

DUPLICATES_ALLOWED

public static final int DUPLICATES_ALLOWED
Flag to say this option may be repeated on the command line
Field Value:
32

Constructor Details

CLOptionDescriptor

public CLOptionDescriptor(String name,
                          int flags,
                          int id,
                          String description)
Constructor.
Parameters:
name - the name/long option
flags - the flags
id - the id/character option
description - description of option usage

CLOptionDescriptor

public CLOptionDescriptor(String name,
                          int flags,
                          int id,
                          String description,
                          int[] incompatable)
Constructor.
Parameters:
name - the name/long option
flags - the flags
id - the id/character option
description - description of option usage

Method Details

getDescription

public final String getDescription()
Retrieve textual description.
Returns:
the description

getFlags

public final int getFlags()
Retrieve flags about option. Flags include details such as whether it allows parameters etc.
Returns:
the flags

getId

public final int getId()
Retrieve the id for option. The id is also the character if using single character options.
Returns:
the id

getIncompatble

protected final int[] getIncompatble()

Deprecated. Use the correctly spelled getIncompatible() instead.


getIncompatible

protected final int[] getIncompatible()

getName

public final String getName()
Retrieve name of option which is also text for long option.
Returns:
name/long option

toString

public final String toString()
Convert to String.
Returns:
the converted value to string.

Copyright © 2005 Apache Web Services Project. All Rights Reserved.