org.unix4j.option

Class DefaultOptionSet<E extends Enum<E> & Option>

java.lang.Object

org.unix4j.option.DefaultOptionSet<E>

Type Parameters:

E - the option enum type

All Implemented Interfaces:

Cloneable, Iterable<E>, OptionSet<E>

Direct Known Subclasses:

CatOptions.Default, CutOptions.Default, EchoOptions.Default, FindOptions.Default, GrepOptions.Default, HeadOptions.Default, LsOptions.Default, SedOptions.Default, SortOptions.Default, TailOptions.Default, UniqOptions.Default, WcOptions.Default, XargsOptions.Default

public class DefaultOptionSet<E extends Enum<E> & Option>
extends Object
implements OptionSet<E>, Iterable<E>, Cloneable

Default implementation of a modifiable option set. The option set is backed by an efficient EnumSet.

Constructor Summary

Constructors

Constructor and Description
DefaultOptionSet(Class<E> optionType) Constructor for an empty option set with no active options.
DefaultOptionSet(E option) Constructor for option set initialized with a single option.
DefaultOptionSet(E first, E... rest) Constructor for option set initialized with at least one active options.

Method Summary

Methods

Modifier and Type	Method and Description
EnumSet<E>	asSet() Returns the underlying backing EnumSet.
DefaultOptionSet<E>	clone()
boolean	equals(Object o)
int	hashCode()
boolean	isEmpty() Returns true if no option is set.
boolean	isSet(E option) Returns true if the specified option is set and false otherwise
Iterator<E>	iterator() Returns an iterator over all set options in this OptionSet.
Class<E>	optionType() Returns the option type class, usually an enum.
void	set(E option) Sets the specified option.
void	setAll(Collection<? extends E> options) Sets all specified options.
void	setAll(E... options) Sets all specified options.
void	setAll(OptionSet<E> optionSet) Sets all the options contained in the specified optionSet.
void	setUseAcronymFor(E option, boolean useAcronym) Sets the flag indicating whether string representations should use the acronym instead of the long option name for the specified option.
void	setUseAcronymForAll(boolean useAcronym) Sets the flag indicating whether string representations should use the acronym instead of the long option name for all options.
int	size() Returns the number of set options in this OptionSet
String	toString()
static <O extends Option> String	toString(OptionSet<O> optionSet)
boolean	useAcronymFor(E option) Returns true if the acronym should be used in for the specified option string representations.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultOptionSet

public DefaultOptionSet(E option)

Constructor for option set initialized with a single option.

Parameters:

option - the option to be set

DefaultOptionSet

public DefaultOptionSet(E first,
                E... rest)

Constructor for option set initialized with at least one active options.

Parameters:

first - the first option to be set

rest - the remaining options to be set

DefaultOptionSet

public DefaultOptionSet(Class<E> optionType)

Constructor for an empty option set with no active options.

Parameters:

optionType - the option type class

Method Detail

optionType

public Class<E> optionType()

Description copied from interface: OptionSet

Returns the option type class, usually an enum.

Specified by:

optionType in interface OptionSet<E extends Enum<E> & Option>

Returns:

the option type

set

public void set(E option)

Sets the specified option.

Parameters:

option - the option to set

setAll

public void setAll(E... options)

Sets all specified options.

Parameters:

options - the options to set

setAll

public void setAll(Collection<? extends E> options)

Sets all specified options.

Parameters:

options - the options to set

setAll

public void setAll(OptionSet<E> optionSet)

Sets all the options contained in the specified optionSet.

Note that also the OptionSet.useAcronymFor(Option) flags are also inherited from the specified optionSet.

Parameters:

optionSet - the optionSet with options to be set in this OptionSet

isSet

public boolean isSet(E option)

Description copied from interface: OptionSet

Returns true if the specified option is set and false otherwise

Specified by:

isSet in interface OptionSet<E extends Enum<E> & Option>

Parameters:

option - the option to test

Returns:

true if option is set in this OptionSet

size

public int size()

Returns the number of set options in this OptionSet

Specified by:

size in interface OptionSet<E extends Enum<E> & Option>

Returns:

the number of set options

isEmpty

public boolean isEmpty()

Returns true if no option is set.

Returns:

true if no option is set.

asSet

public EnumSet<E> asSet()

Returns the underlying backing EnumSet. Changing the returned set will also alter this OptionSet and vice versa.

Specified by:

asSet in interface OptionSet<E extends Enum<E> & Option>

Returns:

the underlying backing enum set

iterator

public Iterator<E> iterator()

Returns an iterator over all set options in this OptionSet. Removing an option from the

Specified by:

iterator in interface Iterable<E extends Enum<E> & Option>

Specified by:

iterator in interface OptionSet<E extends Enum<E> & Option>

Returns:

an iterator over all set options

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

clone

public DefaultOptionSet<E> clone()

Overrides:

clone in class Object

useAcronymFor

public boolean useAcronymFor(E option)

Description copied from interface: OptionSet

Returns true if the acronym should be used in for the specified option string representations. Note that some implementations may return the same value for all options.

Specified by:

useAcronymFor in interface OptionSet<E extends Enum<E> & Option>

Parameters:

option - the option of interest

Returns:

true if the acronym should be used in string representations for the specified option

setUseAcronymForAll

public void setUseAcronymForAll(boolean useAcronym)

Sets the flag indicating whether string representations should use the acronym instead of the long option name for all options.

Parameters:

useAcronym - new flag value to set, true if the option acronym should be used for all options

See Also:

setUseAcronymFor(Enum, boolean)

setUseAcronymFor

public void setUseAcronymFor(E option,
                    boolean useAcronym)

Sets the flag indicating whether string representations should use the acronym instead of the long option name for the specified option.

Parameters:

option - the option for which this flag is set

useAcronym - new flag value to set, true if the option acronym should be used for the specified option

See Also:

setUseAcronymForAll(boolean)

toString

public String toString()

Overrides:

toString in class Object

toString

public static <O extends Option> String toString(OptionSet<O> optionSet)