org.unix4j.unix.sort

Enum SortOptionSet_bcdfhru

java.lang.Object

java.lang.Enum<SortOptionSet_bcdfhru>

org.unix4j.unix.sort.SortOptionSet_bcdfhru

All Implemented Interfaces:

Serializable, Comparable<SortOptionSet_bcdfhru>, Iterable<SortOption>, OptionSet<SortOption>, SortOptions

public enum SortOptionSet_bcdfhru
extends Enum<SortOptionSet_bcdfhru>
implements SortOptions

Option sets for the sort command with the following options: c, d, h, f, b, r, u.

Application code does normally not directly refer to this class; Sort.Options should be used instead to specify command options. See also SortOptions for more information.

Nested Class Summary

Nested classes/interfaces inherited from interface org.unix4j.unix.sort.SortOptions

SortOptions.Default

Enum Constant Summary

Enum Constants

Enum Constant and Description
Active_bcdfh Option set with the following active options: c, d, h, f, b.
Active_bcdfh_long Option set with the following active options: c, d, h, f, b.
Active_bcdfhr Option set with the following active options: c, d, h, f, b, r.
Active_bcdfhr_long Option set with the following active options: c, d, h, f, b, r.
Active_bcdfhru Option set with the following active options: c, d, h, f, b, r, u.
Active_bcdfhru_long Option set with the following active options: c, d, h, f, b, r, u.
Active_bcdfhu Option set with the following active options: c, d, h, f, b, u.
Active_bcdfhu_long Option set with the following active options: c, d, h, f, b, u.
Active_bcdh Option set with the following active options: c, d, h, b.
Active_bcdh_long Option set with the following active options: c, d, h, b.
Active_bcdhr Option set with the following active options: c, d, h, b, r.
Active_bcdhr_long Option set with the following active options: c, d, h, b, r.
Active_bcdhru Option set with the following active options: c, d, h, b, r, u.
Active_bcdhru_long Option set with the following active options: c, d, h, b, r, u.
Active_bcdhu Option set with the following active options: c, d, h, b, u.
Active_bcdhu_long Option set with the following active options: c, d, h, b, u.
Active_bcfh Option set with the following active options: c, h, f, b.
Active_bcfh_long Option set with the following active options: c, h, f, b.
Active_bcfhr Option set with the following active options: c, h, f, b, r.
Active_bcfhr_long Option set with the following active options: c, h, f, b, r.
Active_bcfhru Option set with the following active options: c, h, f, b, r, u.
Active_bcfhru_long Option set with the following active options: c, h, f, b, r, u.
Active_bcfhu Option set with the following active options: c, h, f, b, u.
Active_bcfhu_long Option set with the following active options: c, h, f, b, u.
Active_bch Option set with the following active options: c, h, b.
Active_bch_long Option set with the following active options: c, h, b.
Active_bchr Option set with the following active options: c, h, b, r.
Active_bchr_long Option set with the following active options: c, h, b, r.
Active_bchru Option set with the following active options: c, h, b, r, u.
Active_bchru_long Option set with the following active options: c, h, b, r, u.
Active_bchu Option set with the following active options: c, h, b, u.
Active_bchu_long Option set with the following active options: c, h, b, u.
Active_cdfh Option set with the following active options: c, d, h, f.
Active_cdfh_long Option set with the following active options: c, d, h, f.
Active_cdfhr Option set with the following active options: c, d, h, f, r.
Active_cdfhr_long Option set with the following active options: c, d, h, f, r.
Active_cdfhru Option set with the following active options: c, d, h, f, r, u.
Active_cdfhru_long Option set with the following active options: c, d, h, f, r, u.
Active_cdfhu Option set with the following active options: c, d, h, f, u.
Active_cdfhu_long Option set with the following active options: c, d, h, f, u.
Active_cdh Option set with the following active options: c, d, h.
Active_cdh_long Option set with the following active options: c, d, h.
Active_cdhr Option set with the following active options: c, d, h, r.
Active_cdhr_long Option set with the following active options: c, d, h, r.
Active_cdhru Option set with the following active options: c, d, h, r, u.
Active_cdhru_long Option set with the following active options: c, d, h, r, u.
Active_cdhu Option set with the following active options: c, d, h, u.
Active_cdhu_long Option set with the following active options: c, d, h, u.
Active_cfh Option set with the following active options: c, h, f.
Active_cfh_long Option set with the following active options: c, h, f.
Active_cfhr Option set with the following active options: c, h, f, r.
Active_cfhr_long Option set with the following active options: c, h, f, r.
Active_cfhru Option set with the following active options: c, h, f, r, u.
Active_cfhru_long Option set with the following active options: c, h, f, r, u.
Active_cfhu Option set with the following active options: c, h, f, u.
Active_cfhu_long Option set with the following active options: c, h, f, u.
Active_ch Option set with the following active options: c, h.
Active_ch_long Option set with the following active options: c, h.
Active_chr Option set with the following active options: c, h, r.
Active_chr_long Option set with the following active options: c, h, r.
Active_chru Option set with the following active options: c, h, r, u.
Active_chru_long Option set with the following active options: c, h, r, u.
Active_chu Option set with the following active options: c, h, u.
Active_chu_long Option set with the following active options: c, h, u.

Field Summary

Fields

Modifier and Type	Field and Description
SortOptionSet_bcdfhru	b Option "-b": Ignore leading blanks.
SortOptionSet_bcdfhru	c Option "-c": Checks that the single input file is ordered as specified by the arguments and the collating sequence of the current locale.
SortOptionSet_bcdfhru	check Option "--check": Checks that the single input file is ordered as specified by the arguments and the collating sequence of the current locale.
SortOptionSet_bcdfhru	d Option "-d": Consider only blanks and alphanumeric characters.
SortOptionSet_bcdfhru	dictionaryOrder Option "--dictionaryOrder": Consider only blanks and alphanumeric characters.
SortOptionSet_bcdfhru	f Option "-f": Consider all lowercase characters that have uppercase equivalents to be the uppercase equivalent for the purposes of comparison.
SortOptionSet_bcdfhru	h Option "-h": Sort numerically, first by numeric sign (negative, zero, or positive); then by SI suffix (either empty, or 'k' or 'K', or one of 'MGTPEZY', in that order); and finally by numeric value.
SortOptionSet_bcdfhru	humanNumericSort Option "--humanNumericSort": Sort numerically, first by numeric sign (negative, zero, or positive); then by SI suffix (either empty, or 'k' or 'K', or one of 'MGTPEZY', in that order); and finally by numeric value.
SortOptionSet_bcdfhru	ignoreCase Option "--ignoreCase": Consider all lowercase characters that have uppercase equivalents to be the uppercase equivalent for the purposes of comparison.
SortOptionSet_bcdfhru	ignoreLeadingBlanks Option "--ignoreLeadingBlanks": Ignore leading blanks.
SortOptionSet_bcdfhru	r Option "-r": Reverse the sense of comparisons.
SortOptionSet_bcdfhru	reverse Option "--reverse": Reverse the sense of comparisons.
SortOptionSet_bcdfhru	u Option "-u": Unique: suppress all but one in each set of lines having equal keys.
SortOptionSet_bcdfhru	unique Option "--unique": Unique: suppress all but one in each set of lines having equal keys.

Fields inherited from interface org.unix4j.unix.sort.SortOptions

CONVERTER, EMPTY

Method Summary

Methods

Modifier and Type	Method and Description
EnumSet<SortOption>	asSet() Returns the set with the active options.
boolean	isSet(SortOption option) Returns true if the specified option is set and false otherwise
Iterator<SortOption>	iterator() Returns an immutable iterator with the active options of this option set.
Class<SortOption>	optionType() Returns the option type class, usually an enum.
int	size() Returns the number of active options in this option set.
boolean	useAcronymFor(SortOption option) Returns true if the acronym should be used in for the specified option string representations.
static SortOptionSet_bcdfhru	valueOf(String name) Returns the enum constant of this type with the specified name.
static SortOptionSet_bcdfhru[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Active_bcdfhru

public static final SortOptionSet_bcdfhru Active_bcdfhru

Option set with the following active options: c, d, h, f, b, r, u.

Active_bcdfhru_long

public static final SortOptionSet_bcdfhru Active_bcdfhru_long

Option set with the following active options: c, d, h, f, b, r, u.

Active_bcdfhu

public static final SortOptionSet_bcdfhru Active_bcdfhu

Option set with the following active options: c, d, h, f, b, u.

Active_bcdfhu_long

public static final SortOptionSet_bcdfhru Active_bcdfhu_long

Option set with the following active options: c, d, h, f, b, u.

Active_bcdhru

public static final SortOptionSet_bcdfhru Active_bcdhru

Option set with the following active options: c, d, h, b, r, u.

Active_bcdhru_long

public static final SortOptionSet_bcdfhru Active_bcdhru_long

Option set with the following active options: c, d, h, b, r, u.

Active_bcfhru

public static final SortOptionSet_bcdfhru Active_bcfhru

Option set with the following active options: c, h, f, b, r, u.

Active_bcfhru_long

public static final SortOptionSet_bcdfhru Active_bcfhru_long

Option set with the following active options: c, h, f, b, r, u.

Active_cdfhru

public static final SortOptionSet_bcdfhru Active_cdfhru

Option set with the following active options: c, d, h, f, r, u.

Active_cdfhru_long

public static final SortOptionSet_bcdfhru Active_cdfhru_long

Option set with the following active options: c, d, h, f, r, u.

Active_bcdfhr

public static final SortOptionSet_bcdfhru Active_bcdfhr

Option set with the following active options: c, d, h, f, b, r.

Active_bcdfhr_long

public static final SortOptionSet_bcdfhru Active_bcdfhr_long

Option set with the following active options: c, d, h, f, b, r.

Active_bcdhu

public static final SortOptionSet_bcdfhru Active_bcdhu

Option set with the following active options: c, d, h, b, u.

Active_bcdhu_long

public static final SortOptionSet_bcdfhru Active_bcdhu_long

Option set with the following active options: c, d, h, b, u.

Active_bcfhu

public static final SortOptionSet_bcdfhru Active_bcfhu

Option set with the following active options: c, h, f, b, u.

Active_bcfhu_long

public static final SortOptionSet_bcdfhru Active_bcfhu_long

Option set with the following active options: c, h, f, b, u.

Active_bchru

public static final SortOptionSet_bcdfhru Active_bchru

Option set with the following active options: c, h, b, r, u.

Active_bchru_long

public static final SortOptionSet_bcdfhru Active_bchru_long

Option set with the following active options: c, h, b, r, u.

Active_cdfhu

public static final SortOptionSet_bcdfhru Active_cdfhu

Option set with the following active options: c, d, h, f, u.

Active_cdfhu_long

public static final SortOptionSet_bcdfhru Active_cdfhu_long

Option set with the following active options: c, d, h, f, u.

Active_cdhru

public static final SortOptionSet_bcdfhru Active_cdhru

Option set with the following active options: c, d, h, r, u.

Active_cdhru_long

public static final SortOptionSet_bcdfhru Active_cdhru_long

Option set with the following active options: c, d, h, r, u.

Active_cfhru

public static final SortOptionSet_bcdfhru Active_cfhru

Option set with the following active options: c, h, f, r, u.

Active_cfhru_long

public static final SortOptionSet_bcdfhru Active_cfhru_long

Option set with the following active options: c, h, f, r, u.

Active_bcdfh

public static final SortOptionSet_bcdfhru Active_bcdfh

Option set with the following active options: c, d, h, f, b.

Active_bcdfh_long

public static final SortOptionSet_bcdfhru Active_bcdfh_long

Option set with the following active options: c, d, h, f, b.

Active_bcdhr

public static final SortOptionSet_bcdfhru Active_bcdhr

Option set with the following active options: c, d, h, b, r.

Active_bcdhr_long

public static final SortOptionSet_bcdfhru Active_bcdhr_long

Option set with the following active options: c, d, h, b, r.

Active_bcfhr

public static final SortOptionSet_bcdfhru Active_bcfhr

Option set with the following active options: c, h, f, b, r.

Active_bcfhr_long

public static final SortOptionSet_bcdfhru Active_bcfhr_long

Option set with the following active options: c, h, f, b, r.

Active_cdfhr

public static final SortOptionSet_bcdfhru Active_cdfhr

Option set with the following active options: c, d, h, f, r.

Active_cdfhr_long

public static final SortOptionSet_bcdfhru Active_cdfhr_long

Option set with the following active options: c, d, h, f, r.

Active_bchu

public static final SortOptionSet_bcdfhru Active_bchu

Option set with the following active options: c, h, b, u.

Active_bchu_long

public static final SortOptionSet_bcdfhru Active_bchu_long

Option set with the following active options: c, h, b, u.

Active_cdhu

public static final SortOptionSet_bcdfhru Active_cdhu

Option set with the following active options: c, d, h, u.

Active_cdhu_long

public static final SortOptionSet_bcdfhru Active_cdhu_long

Option set with the following active options: c, d, h, u.

Active_cfhu

public static final SortOptionSet_bcdfhru Active_cfhu

Option set with the following active options: c, h, f, u.

Active_cfhu_long

public static final SortOptionSet_bcdfhru Active_cfhu_long

Option set with the following active options: c, h, f, u.

Active_chru

public static final SortOptionSet_bcdfhru Active_chru

Option set with the following active options: c, h, r, u.

Active_chru_long

public static final SortOptionSet_bcdfhru Active_chru_long

Option set with the following active options: c, h, r, u.

Active_bcdh

public static final SortOptionSet_bcdfhru Active_bcdh

Option set with the following active options: c, d, h, b.

Active_bcdh_long

public static final SortOptionSet_bcdfhru Active_bcdh_long

Option set with the following active options: c, d, h, b.

Active_bcfh

public static final SortOptionSet_bcdfhru Active_bcfh

Option set with the following active options: c, h, f, b.

Active_bcfh_long

public static final SortOptionSet_bcdfhru Active_bcfh_long

Option set with the following active options: c, h, f, b.

Active_bchr

public static final SortOptionSet_bcdfhru Active_bchr

Option set with the following active options: c, h, b, r.

Active_bchr_long

public static final SortOptionSet_bcdfhru Active_bchr_long

Option set with the following active options: c, h, b, r.

Active_cdfh

public static final SortOptionSet_bcdfhru Active_cdfh

Option set with the following active options: c, d, h, f.

Active_cdfh_long

public static final SortOptionSet_bcdfhru Active_cdfh_long

Option set with the following active options: c, d, h, f.

Active_cdhr

public static final SortOptionSet_bcdfhru Active_cdhr

Option set with the following active options: c, d, h, r.

Active_cdhr_long

public static final SortOptionSet_bcdfhru Active_cdhr_long

Option set with the following active options: c, d, h, r.

Active_cfhr

public static final SortOptionSet_bcdfhru Active_cfhr

Option set with the following active options: c, h, f, r.

Active_cfhr_long

public static final SortOptionSet_bcdfhru Active_cfhr_long

Option set with the following active options: c, h, f, r.

Active_chu

public static final SortOptionSet_bcdfhru Active_chu

Option set with the following active options: c, h, u.

Active_chu_long

public static final SortOptionSet_bcdfhru Active_chu_long

Option set with the following active options: c, h, u.

Active_bch

public static final SortOptionSet_bcdfhru Active_bch

Option set with the following active options: c, h, b.

Active_bch_long

public static final SortOptionSet_bcdfhru Active_bch_long

Option set with the following active options: c, h, b.

Active_cdh

public static final SortOptionSet_bcdfhru Active_cdh

Option set with the following active options: c, d, h.

Active_cdh_long

public static final SortOptionSet_bcdfhru Active_cdh_long

Option set with the following active options: c, d, h.

Active_cfh

public static final SortOptionSet_bcdfhru Active_cfh

Option set with the following active options: c, h, f.

Active_cfh_long

public static final SortOptionSet_bcdfhru Active_cfh_long

Option set with the following active options: c, h, f.

Active_chr

public static final SortOptionSet_bcdfhru Active_chr

Option set with the following active options: c, h, r.

Active_chr_long

public static final SortOptionSet_bcdfhru Active_chr_long

Option set with the following active options: c, h, r.

Active_ch

public static final SortOptionSet_bcdfhru Active_ch

Option set with the following active options: c, h.

Active_ch_long

public static final SortOptionSet_bcdfhru Active_ch_long

Option set with the following active options: c, h.

Field Detail

c

public final SortOptionSet_bcdfhru c

Option "-c": Checks that the single input file is ordered as specified by the arguments and the collating sequence of the current locale. No output is produced; only the exit code is affected.

The option "-c" is equivalent to the "--check" option.

Technically speaking, this field points to a set with the options of the current set plus the option "-c". If the option "-c" is already set, the field c points to the enum constant itself as it already represents the current set of options.

check

public final SortOptionSet_bcdfhru check

Option "--check": Checks that the single input file is ordered as specified by the arguments and the collating sequence of the current locale. No output is produced; only the exit code is affected.

The option "--check" is equivalent to the "-c" option.

Technically speaking, this field points to a set with the options of the current set plus the option "--check". If the option "--check" is already set, the field check points to the enum constant itself as it already represents the current set of options.

d

public final SortOptionSet_bcdfhru d

Option "-d": Consider only blanks and alphanumeric characters. (This option is ignored if a comparator operand is present).

The option "-d" is equivalent to the "--dictionaryOrder" option.

Technically speaking, this field points to a set with the options of the current set plus the option "-d". If the option "-d" is already set, the field d points to the enum constant itself as it already represents the current set of options.

dictionaryOrder

public final SortOptionSet_bcdfhru dictionaryOrder

Option "--dictionaryOrder": Consider only blanks and alphanumeric characters. (This option is ignored if a comparator operand is present).

The option "--dictionaryOrder" is equivalent to the "-d" option.

Technically speaking, this field points to a set with the options of the current set plus the option "--dictionaryOrder". If the option "--dictionaryOrder" is already set, the field dictionaryOrder points to the enum constant itself as it already represents the current set of options.

h

public final SortOptionSet_bcdfhru h

Option "-h": Sort numerically, first by numeric sign (negative, zero, or positive); then by SI suffix (either empty, or 'k' or 'K', or one of 'MGTPEZY', in that order); and finally by numeric value. For example, '1023M' sorts before '1G' because 'M' (mega) precedes 'G' (giga) as an SI suffix.

This option sorts values that are consistently scaled to the nearest suffix, regardless of whether suffixes denote powers of 1000 or 1024, and it therefore sorts the output of any single invocation of the ls command that are invoked with the --human-readable option.

The syntax for numbers is the same as for the --numericSort (-n) option; the SI suffix must immediately follow the number.

(This option is ignored if a comparator operand is present).

The option "-h" is equivalent to the "--humanNumericSort" option.

Technically speaking, this field points to a set with the options of the current set plus the option "-h". If the option "-h" is already set, the field h points to the enum constant itself as it already represents the current set of options.

humanNumericSort

public final SortOptionSet_bcdfhru humanNumericSort

Option "--humanNumericSort": Sort numerically, first by numeric sign (negative, zero, or positive); then by SI suffix (either empty, or 'k' or 'K', or one of 'MGTPEZY', in that order); and finally by numeric value. For example, '1023M' sorts before '1G' because 'M' (mega) precedes 'G' (giga) as an SI suffix.

This option sorts values that are consistently scaled to the nearest suffix, regardless of whether suffixes denote powers of 1000 or 1024, and it therefore sorts the output of any single invocation of the ls command that are invoked with the --human-readable option.

The syntax for numbers is the same as for the --numericSort (-n) option; the SI suffix must immediately follow the number.

(This option is ignored if a comparator operand is present).

The option "--humanNumericSort" is equivalent to the "-h" option.

Technically speaking, this field points to a set with the options of the current set plus the option "--humanNumericSort". If the option "--humanNumericSort" is already set, the field humanNumericSort points to the enum constant itself as it already represents the current set of options.

f

public final SortOptionSet_bcdfhru f

Option "-f": Consider all lowercase characters that have uppercase equivalents to be the uppercase equivalent for the purposes of comparison. (This option is ignored if a comparator operand is present).

The option "-f" is equivalent to the "--ignoreCase" option.

Technically speaking, this field points to a set with the options of the current set plus the option "-f". If the option "-f" is already set, the field f points to the enum constant itself as it already represents the current set of options.

ignoreCase

public final SortOptionSet_bcdfhru ignoreCase

Option "--ignoreCase": Consider all lowercase characters that have uppercase equivalents to be the uppercase equivalent for the purposes of comparison. (This option is ignored if a comparator operand is present).

The option "--ignoreCase" is equivalent to the "-f" option.

Technically speaking, this field points to a set with the options of the current set plus the option "--ignoreCase". If the option "--ignoreCase" is already set, the field ignoreCase points to the enum constant itself as it already represents the current set of options.

b

public final SortOptionSet_bcdfhru b

Option "-b": Ignore leading blanks. (This option is ignored if a comparator operand is present).

The option "-b" is equivalent to the "--ignoreLeadingBlanks" option.

Technically speaking, this field points to a set with the options of the current set plus the option "-b". If the option "-b" is already set, the field b points to the enum constant itself as it already represents the current set of options.

ignoreLeadingBlanks

public final SortOptionSet_bcdfhru ignoreLeadingBlanks

Option "--ignoreLeadingBlanks": Ignore leading blanks. (This option is ignored if a comparator operand is present).

The option "--ignoreLeadingBlanks" is equivalent to the "-b" option.

Technically speaking, this field points to a set with the options of the current set plus the option "--ignoreLeadingBlanks". If the option "--ignoreLeadingBlanks" is already set, the field ignoreLeadingBlanks points to the enum constant itself as it already represents the current set of options.

r

public final SortOptionSet_bcdfhru r

Option "-r": Reverse the sense of comparisons.

The option "-r" is equivalent to the "--reverse" option.

Technically speaking, this field points to a set with the options of the current set plus the option "-r". If the option "-r" is already set, the field r points to the enum constant itself as it already represents the current set of options.

reverse

public final SortOptionSet_bcdfhru reverse

Option "--reverse": Reverse the sense of comparisons.

The option "--reverse" is equivalent to the "-r" option.

Technically speaking, this field points to a set with the options of the current set plus the option "--reverse". If the option "--reverse" is already set, the field reverse points to the enum constant itself as it already represents the current set of options.

u

public final SortOptionSet_bcdfhru u

Option "-u": Unique: suppress all but one in each set of lines having equal keys. If used with the -c option, checks that there are no lines with duplicate keys, in addition to checking that the input file is sorted.

The option "-u" is equivalent to the "--unique" option.

Technically speaking, this field points to a set with the options of the current set plus the option "-u". If the option "-u" is already set, the field u points to the enum constant itself as it already represents the current set of options.

unique

public final SortOptionSet_bcdfhru unique

Option "--unique": Unique: suppress all but one in each set of lines having equal keys. If used with the -c option, checks that there are no lines with duplicate keys, in addition to checking that the input file is sorted.

The option "--unique" is equivalent to the "-u" option.

Technically speaking, this field points to a set with the options of the current set plus the option "--unique". If the option "--unique" is already set, the field unique points to the enum constant itself as it already represents the current set of options.

Method Detail

values

public static SortOptionSet_bcdfhru[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SortOptionSet_bcdfhru c : SortOptionSet_bcdfhru.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SortOptionSet_bcdfhru valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

optionType

public Class<SortOption> optionType()

Description copied from interface: OptionSet

Returns the option type class, usually an enum.

Specified by:

optionType in interface OptionSet<SortOption>

Returns:

the option type

isSet

public boolean isSet(SortOption option)

Description copied from interface: OptionSet

Returns true if the specified option is set and false otherwise

Specified by:

isSet in interface OptionSet<SortOption>

Parameters:

option - the option to test

Returns:

true if option is set in this OptionSet

size

public int size()

Description copied from interface: OptionSet

Returns the number of active options in this option set.

Specified by:

size in interface OptionSet<SortOption>

Returns:

the number of active options

asSet

public EnumSet<SortOption> asSet()

Returns the set with the active options. The returned set a new defensive copy instance created when this method is called, modifications of this set will therefore not alter this option set.

Specified by:

asSet in interface OptionSet<SortOption>

Returns:

a copy of the set with the active options.

iterator

public Iterator<SortOption> iterator()

Returns an immutable iterator with the active options of this option set.

Specified by:

iterator in interface Iterable<SortOption>

Specified by:

iterator in interface OptionSet<SortOption>

Returns:

an immutable iterator for over the active options

useAcronymFor

public boolean useAcronymFor(SortOption option)

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

In particular and independent from the option argument, this option set returns true if the last option added to this set was an acronym, and false if it was a long option name.

For instance, the set defined as

    SortOptionSet_bcdfhru.check.d;
 

uses acronyms, that is, this method always returns true for the above set.

On the other hand, long option names are used and this method always returns false for the set

    SortOptionSet_bcdfhru.c.dictionaryOrder;
 

Note that a repeated option is not treated as the last set option. For instance, the first and last option of the following set are equivalent and acronyms are used:

    SortOptionSet_bcdfhru.c.d.check;
 

This method always returns true for the empty set with no active options.

Specified by:

useAcronymFor in interface OptionSet<SortOption>

Parameters:

option - the option of interest, has no impact on the result returned by this method

Returns:

true if option acronyms should be used for string representations of any option of this option set