Package org.apache.hadoop.classification.tools

Class StabilityOptions

java.lang.Object

org.apache.hadoop.classification.tools.StabilityOptions

public final class StabilityOptions
extends Object

Doclet option helpers for API stability filtering.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EVOLVING_OPTION	Option flag: -evolving.
static final String	STABLE_OPTION	Option flag: -stable.
static final String	UNSTABLE_OPTION	Option flag: -unstable.

Method Summary

Modifier and Type	Method	Description
static String[][]	filterOptions(String[][] options)	Filter out stability options from the doclet options array.
static Integer	optionLength(String option)	Return option length for a supported stability option.
static void	validOptions(String[][] options, Reporter reporter)	Validate and apply stability options.

Methods inherited from class java.lang.Object

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

Field Details

STABLE_OPTION

public static final String STABLE_OPTION

Option flag: -stable.

See Also:

• Constant Field Values

EVOLVING_OPTION

public static final String EVOLVING_OPTION

Option flag: -evolving.

See Also:

• Constant Field Values

UNSTABLE_OPTION

public static final String UNSTABLE_OPTION

Option flag: -unstable.

See Also:

• Constant Field Values

Method Details

optionLength

public static Integer optionLength(String option)

Return option length for a supported stability option.

Parameters:

option - option name

Returns:

1 if supported; otherwise null

validOptions

public static void validOptions(String[][] options,
 Reporter reporter)

Validate and apply stability options.

Parameters:

options - doclet options

reporter - reporter

filterOptions

public static String[][] filterOptions(String[][] options)

Filter out stability options from the doclet options array.

Parameters:

options - doclet options

Returns:

options without stability flags