OptionSet (unix4j 0.7-SNAPSHOT API)

Type Parameters:

O - the recursive type definition for the implementing option, usually an enum

All Superinterfaces:

Iterable<O>

All Known Subinterfaces:

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

All Known Implementing Classes:

CatOption, CatOptions.Default, CatOptionSet_bns, CatOptionSet_bs, CatOptionSet_ns, CutOption, CutOptions.Default, CutOptionSet_cf, DefaultOptionSet, EchoOption, EchoOptions.Default, EchoOptionSet_n, FindOption, FindOptions.Default, FindOptionSet_acdfilmnorxz, FindOptionSet_acdimnorz, FindOptionSet_acfimnorz, FindOptionSet_acilmnorz, FindOptionSet_acimnorxz, FindOptionSet_adfilnorxz, FindOptionSet_adinorz, FindOptionSet_afinorz, FindOptionSet_ailnorz, FindOptionSet_ainorxz, FindOptionSet_cdfilnorxz, FindOptionSet_cdinorz, FindOptionSet_cfinorz, FindOptionSet_cilnorz, FindOptionSet_cinorxz, FindOptionSet_dfilmnorxz, FindOptionSet_dimnorz, FindOptionSet_fimnorz, FindOptionSet_ilmnorz, FindOptionSet_imnorxz, GrepOption, GrepOptions.Default, GrepOptionSet_Fcilnvx, HeadOption, HeadOptions.Default, HeadOptionSet_cq, LsOption, LsOptions.Default, LsOptionSet_Rahlrt, SedOption, SedOptions.Default, SedOptionSet_Iacdgilnpsy, SedOptionSet_Iaglnp, SedOptionSet_Icglnp, SedOptionSet_Idglnp, SedOptionSet_Igilnp, SedOptionSet_Iglnps, SedOptionSet_Iglnpy, SortOption, SortOptions.Default, SortOptionSet_bcdfgmru, SortOptionSet_bcdfgru, SortOptionSet_bcdfhmru, SortOptionSet_bcdfhru, SortOptionSet_bcdfmnru, SortOptionSet_bcdfnru, SortOptionSet_bdfgmru, SortOptionSet_bdfhmru, SortOptionSet_bdfmnru, SortOptionSet_Mbcdfmru, SortOptionSet_Mbcdfru, SortOptionSet_Mbdfmru, SortOptionSet_MVbcdfghmnru, SortOptionSet_MVbcdfghnru, SortOptionSet_MVbdfghmnru, SortOptionSet_Vbcdfmru, SortOptionSet_Vbcdfru, SortOptionSet_Vbdfmru, TailOption, TailOptions.Default, TailOptionSet_cqs, UniqOption, UniqOptions.Default, UniqOptionSet_cdgu, UniqOptionSet_cg, UniqOptionSet_dg, UniqOptionSet_gu, WcOption, WcOptions.Default, WcOptionSet_lmw, XargsOption, XargsOptions.Default, XargsOptionSet_rtxz
```
public interface OptionSet<O extends Option>
extends Iterable<O>
```
An option set is a very simple unmodifiable set of options.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Set<O>`	`asSet()` Returns the active options in a `Set`.
`boolean`	`isSet(O option)` Returns true if the specified `option` is set and false otherwise
`Iterator<O>`	`iterator()` Returns an iterator over the active options in this option set.
`Class<O>`	`optionType()` Returns the option type class, usually an enum.
`int`	`size()` Returns the number of active options in this option set.
`boolean`	`useAcronymFor(O option)` Returns true if the `acronym` should be used in for the specified `option` string representations.

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - optionType
```
Class<O> optionType()
```
    Returns the option type class, usually an enum.
    
    Returns:
    
    the option type
  - isSet
```
boolean isSet(O option)
```
    Returns true if the specified option is set and false otherwise
    
    Parameters:
    
    option - the option to test
    
    Returns:
    
    true if option is set in this OptionSet
  - asSet
```
Set<O> asSet()
```
    Returns the active options in a Set. It depends on the implementation whether the returned set is modifiable or not.
    
    Returns:
    
    an set containing all active options
  - iterator
```
Iterator<O> iterator()
```
    Returns an iterator over the active options in this option set.
    It depends on the implementation whether the returned iterator is modifiable or not, that is, whether it supports the remove() method.
    
    Specified by:
    
    iterator in interface Iterable<O extends Option>
    
    Returns:
    
    an iterator over all active options
  - size
```
int size()
```
    Returns the number of active options in this option set.
    
    Returns:
    
    the number of active options
  - useAcronymFor
```
boolean useAcronymFor(O option)
```
    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.
    
    Parameters:
    
    option - the option of interest
    
    Returns:
    
    true if the acronym should be used in string representations for the specified option

Interface OptionSet<O extends Option>

Method Summary

Methods inherited from interface java.lang.Iterable

Method Detail

optionType

isSet

asSet

iterator

size

useAcronymFor