org.unix4j.unix.sed

Enum SedOptionSet_Iglnpy

java.lang.Object

java.lang.Enum<SedOptionSet_Iglnpy>

org.unix4j.unix.sed.SedOptionSet_Iglnpy

All Implemented Interfaces:

Serializable, Comparable<SedOptionSet_Iglnpy>, Iterable<SedOption>, OptionSet<SedOption>, SedOptions

public enum SedOptionSet_Iglnpy
extends Enum<SedOptionSet_Iglnpy>
implements SedOptions

Option sets for the sed command with the following options: g, I, l, p, n, y.

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

Nested Class Summary

Nested classes/interfaces inherited from interface org.unix4j.unix.sed.SedOptions

SedOptions.Default

Enum Constant Summary

Enum Constants

Enum Constant and Description
Active_glnpy Option set with the following active options: g, l, p, n, y.
Active_glnpy_long Option set with the following active options: g, l, p, n, y.
Active_glny Option set with the following active options: g, l, n, y.
Active_glny_long Option set with the following active options: g, l, n, y.
Active_glpy Option set with the following active options: g, l, p, y.
Active_glpy_long Option set with the following active options: g, l, p, y.
Active_gly Option set with the following active options: g, l, y.
Active_gly_long Option set with the following active options: g, l, y.
Active_gnpy Option set with the following active options: g, p, n, y.
Active_gnpy_long Option set with the following active options: g, p, n, y.
Active_gny Option set with the following active options: g, n, y.
Active_gny_long Option set with the following active options: g, n, y.
Active_gpy Option set with the following active options: g, p, y.
Active_gpy_long Option set with the following active options: g, p, y.
Active_gy Option set with the following active options: g, y.
Active_gy_long Option set with the following active options: g, y.
Active_Iglnpy Option set with the following active options: g, I, l, p, n, y.
Active_Iglnpy_long Option set with the following active options: g, I, l, p, n, y.
Active_Iglny Option set with the following active options: g, I, l, n, y.
Active_Iglny_long Option set with the following active options: g, I, l, n, y.
Active_Iglpy Option set with the following active options: g, I, l, p, y.
Active_Iglpy_long Option set with the following active options: g, I, l, p, y.
Active_Igly Option set with the following active options: g, I, l, y.
Active_Igly_long Option set with the following active options: g, I, l, y.
Active_Ignpy Option set with the following active options: g, I, p, n, y.
Active_Ignpy_long Option set with the following active options: g, I, p, n, y.
Active_Igny Option set with the following active options: g, I, n, y.
Active_Igny_long Option set with the following active options: g, I, n, y.
Active_Igpy Option set with the following active options: g, I, p, y.
Active_Igpy_long Option set with the following active options: g, I, p, y.
Active_Igy Option set with the following active options: g, I, y.
Active_Igy_long Option set with the following active options: g, I, y.
Active_Ilnpy Option set with the following active options: I, l, p, n, y.
Active_Ilnpy_long Option set with the following active options: I, l, p, n, y.
Active_Ilny Option set with the following active options: I, l, n, y.
Active_Ilny_long Option set with the following active options: I, l, n, y.
Active_Ilpy Option set with the following active options: I, l, p, y.
Active_Ilpy_long Option set with the following active options: I, l, p, y.
Active_Ily Option set with the following active options: I, l, y.
Active_Ily_long Option set with the following active options: I, l, y.
Active_Inpy Option set with the following active options: I, p, n, y.
Active_Inpy_long Option set with the following active options: I, p, n, y.
Active_Iny Option set with the following active options: I, n, y.
Active_Iny_long Option set with the following active options: I, n, y.
Active_Ipy Option set with the following active options: I, p, y.
Active_Ipy_long Option set with the following active options: I, p, y.
Active_Iy Option set with the following active options: I, y.
Active_Iy_long Option set with the following active options: I, y.
Active_lnpy Option set with the following active options: l, p, n, y.
Active_lnpy_long Option set with the following active options: l, p, n, y.
Active_lny Option set with the following active options: l, n, y.
Active_lny_long Option set with the following active options: l, n, y.
Active_lpy Option set with the following active options: l, p, y.
Active_lpy_long Option set with the following active options: l, p, y.
Active_ly Option set with the following active options: l, y.
Active_ly_long Option set with the following active options: l, y.
Active_npy Option set with the following active options: p, n, y.
Active_npy_long Option set with the following active options: p, n, y.
Active_ny Option set with the following active options: n, y.
Active_ny_long Option set with the following active options: n, y.
Active_py Option set with the following active options: p, y.
Active_py_long Option set with the following active options: p, y.
Active_y Option set with the following active options: y.
Active_y_long Option set with the following active options: y.

Field Summary

Fields

Modifier and Type	Field and Description
SedOptionSet_Iglnpy	g Option "-g": Globally substitute for all non-overlapping instances of the regexp rather than just the first one.
SedOptionSet_Iglnpy	global Option "--global": Globally substitute for all non-overlapping instances of the regexp rather than just the first one.
SedOptionSet_Iglnpy	I Option "-I": Use case insensitive pattern matching.
SedOptionSet_Iglnpy	ignoreCase Option "--ignoreCase": Use case insensitive pattern matching.
SedOptionSet_Iglnpy	l Option "-l": Writes the current line number on a separate line to the standard output.
SedOptionSet_Iglnpy	lineNumber Option "--lineNumber": Writes the current line number on a separate line to the standard output.
SedOptionSet_Iglnpy	n Option "-n": Suppress the default output (in which each line, after it is examined for editing, is written to standard output).
SedOptionSet_Iglnpy	p Option "-p": Write the matched line to standard output.
SedOptionSet_Iglnpy	print Option "--print": Write the matched line to standard output.
SedOptionSet_Iglnpy	quiet Option "--quiet": Suppress the default output (in which each line, after it is examined for editing, is written to standard output).
SedOptionSet_Iglnpy	translate Option "--translate": Replace all occurrences of characters in string1 with the corresponding characters in string2.
SedOptionSet_Iglnpy	y Option "-y": Replace all occurrences of characters in string1 with the corresponding characters in string2.

Fields inherited from interface org.unix4j.unix.sed.SedOptions

CONVERTER, EMPTY

Method Summary

Modifier and Type	Method and Description
EnumSet<SedOption>	asSet() Returns the set with the active options.
boolean	isSet(SedOption option) Returns true if the specified option is set and false otherwise
Iterator<SedOption>	iterator() Returns an immutable iterator with the active options of this option set.
Class<SedOption>	optionType() Returns the option type class, usually an enum.
int	size() Returns the number of active options in this option set.
boolean	useAcronymFor(SedOption option) Returns true if the acronym should be used in for the specified option string representations.
static SedOptionSet_Iglnpy	valueOf(String name) Returns the enum constant of this type with the specified name.
static SedOptionSet_Iglnpy[]	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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Enum Constant Detail

Active_Iglnpy

public static final SedOptionSet_Iglnpy Active_Iglnpy

Option set with the following active options: g, I, l, p, n, y.

Active_Iglnpy_long

public static final SedOptionSet_Iglnpy Active_Iglnpy_long

Option set with the following active options: g, I, l, p, n, y.

Active_glnpy

public static final SedOptionSet_Iglnpy Active_glnpy

Option set with the following active options: g, l, p, n, y.

Active_glnpy_long

public static final SedOptionSet_Iglnpy Active_glnpy_long

Option set with the following active options: g, l, p, n, y.

Active_Ignpy

public static final SedOptionSet_Iglnpy Active_Ignpy

Option set with the following active options: g, I, p, n, y.

Active_Ignpy_long

public static final SedOptionSet_Iglnpy Active_Ignpy_long

Option set with the following active options: g, I, p, n, y.

Active_Iglny

public static final SedOptionSet_Iglnpy Active_Iglny

Option set with the following active options: g, I, l, n, y.

Active_Iglny_long

public static final SedOptionSet_Iglnpy Active_Iglny_long

Option set with the following active options: g, I, l, n, y.

Active_Ilnpy

public static final SedOptionSet_Iglnpy Active_Ilnpy

Option set with the following active options: I, l, p, n, y.

Active_Ilnpy_long

public static final SedOptionSet_Iglnpy Active_Ilnpy_long

Option set with the following active options: I, l, p, n, y.

Active_Iglpy

public static final SedOptionSet_Iglnpy Active_Iglpy

Option set with the following active options: g, I, l, p, y.

Active_Iglpy_long

public static final SedOptionSet_Iglnpy Active_Iglpy_long

Option set with the following active options: g, I, l, p, y.

Active_gnpy

public static final SedOptionSet_Iglnpy Active_gnpy

Option set with the following active options: g, p, n, y.

Active_gnpy_long

public static final SedOptionSet_Iglnpy Active_gnpy_long

Option set with the following active options: g, p, n, y.

Active_glny

public static final SedOptionSet_Iglnpy Active_glny

Option set with the following active options: g, l, n, y.

Active_glny_long

public static final SedOptionSet_Iglnpy Active_glny_long

Option set with the following active options: g, l, n, y.

Active_Igny

public static final SedOptionSet_Iglnpy Active_Igny

Option set with the following active options: g, I, n, y.

Active_Igny_long

public static final SedOptionSet_Iglnpy Active_Igny_long

Option set with the following active options: g, I, n, y.

Active_lnpy

public static final SedOptionSet_Iglnpy Active_lnpy

Option set with the following active options: l, p, n, y.

Active_lnpy_long

public static final SedOptionSet_Iglnpy Active_lnpy_long

Option set with the following active options: l, p, n, y.

Active_Inpy

public static final SedOptionSet_Iglnpy Active_Inpy

Option set with the following active options: I, p, n, y.

Active_Inpy_long

public static final SedOptionSet_Iglnpy Active_Inpy_long

Option set with the following active options: I, p, n, y.

Active_Ilny

public static final SedOptionSet_Iglnpy Active_Ilny

Option set with the following active options: I, l, n, y.

Active_Ilny_long

public static final SedOptionSet_Iglnpy Active_Ilny_long

Option set with the following active options: I, l, n, y.

Active_glpy

public static final SedOptionSet_Iglnpy Active_glpy

Option set with the following active options: g, l, p, y.

Active_glpy_long

public static final SedOptionSet_Iglnpy Active_glpy_long

Option set with the following active options: g, l, p, y.

Active_Igpy

public static final SedOptionSet_Iglnpy Active_Igpy

Option set with the following active options: g, I, p, y.

Active_Igpy_long

public static final SedOptionSet_Iglnpy Active_Igpy_long

Option set with the following active options: g, I, p, y.

Active_Igly

public static final SedOptionSet_Iglnpy Active_Igly

Option set with the following active options: g, I, l, y.

Active_Igly_long

public static final SedOptionSet_Iglnpy Active_Igly_long

Option set with the following active options: g, I, l, y.

Active_Ilpy

public static final SedOptionSet_Iglnpy Active_Ilpy

Option set with the following active options: I, l, p, y.

Active_Ilpy_long

public static final SedOptionSet_Iglnpy Active_Ilpy_long

Option set with the following active options: I, l, p, y.

Active_gny

public static final SedOptionSet_Iglnpy Active_gny

Option set with the following active options: g, n, y.

Active_gny_long

public static final SedOptionSet_Iglnpy Active_gny_long

Option set with the following active options: g, n, y.

Active_npy

public static final SedOptionSet_Iglnpy Active_npy

Option set with the following active options: p, n, y.

Active_npy_long

public static final SedOptionSet_Iglnpy Active_npy_long

Option set with the following active options: p, n, y.

Active_lny

public static final SedOptionSet_Iglnpy Active_lny

Option set with the following active options: l, n, y.

Active_lny_long

public static final SedOptionSet_Iglnpy Active_lny_long

Option set with the following active options: l, n, y.

Active_Iny

public static final SedOptionSet_Iglnpy Active_Iny

Option set with the following active options: I, n, y.

Active_Iny_long

public static final SedOptionSet_Iglnpy Active_Iny_long

Option set with the following active options: I, n, y.

Active_gpy

public static final SedOptionSet_Iglnpy Active_gpy

Option set with the following active options: g, p, y.

Active_gpy_long

public static final SedOptionSet_Iglnpy Active_gpy_long

Option set with the following active options: g, p, y.

Active_gly

public static final SedOptionSet_Iglnpy Active_gly

Option set with the following active options: g, l, y.

Active_gly_long

public static final SedOptionSet_Iglnpy Active_gly_long

Option set with the following active options: g, l, y.

Active_Igy

public static final SedOptionSet_Iglnpy Active_Igy

Option set with the following active options: g, I, y.

Active_Igy_long

public static final SedOptionSet_Iglnpy Active_Igy_long

Option set with the following active options: g, I, y.

Active_lpy

public static final SedOptionSet_Iglnpy Active_lpy

Option set with the following active options: l, p, y.

Active_lpy_long

public static final SedOptionSet_Iglnpy Active_lpy_long

Option set with the following active options: l, p, y.

Active_Ipy

public static final SedOptionSet_Iglnpy Active_Ipy

Option set with the following active options: I, p, y.

Active_Ipy_long

public static final SedOptionSet_Iglnpy Active_Ipy_long

Option set with the following active options: I, p, y.

Active_Ily

public static final SedOptionSet_Iglnpy Active_Ily

Option set with the following active options: I, l, y.

Active_Ily_long

public static final SedOptionSet_Iglnpy Active_Ily_long

Option set with the following active options: I, l, y.

Active_ny

public static final SedOptionSet_Iglnpy Active_ny

Option set with the following active options: n, y.

Active_ny_long

public static final SedOptionSet_Iglnpy Active_ny_long

Option set with the following active options: n, y.

Active_gy

public static final SedOptionSet_Iglnpy Active_gy

Option set with the following active options: g, y.

Active_gy_long

public static final SedOptionSet_Iglnpy Active_gy_long

Option set with the following active options: g, y.

Active_py

public static final SedOptionSet_Iglnpy Active_py

Option set with the following active options: p, y.

Active_py_long

public static final SedOptionSet_Iglnpy Active_py_long

Option set with the following active options: p, y.

Active_ly

public static final SedOptionSet_Iglnpy Active_ly

Option set with the following active options: l, y.

Active_ly_long

public static final SedOptionSet_Iglnpy Active_ly_long

Option set with the following active options: l, y.

Active_Iy

public static final SedOptionSet_Iglnpy Active_Iy

Option set with the following active options: I, y.

Active_Iy_long

public static final SedOptionSet_Iglnpy Active_Iy_long

Option set with the following active options: I, y.

Active_y

public static final SedOptionSet_Iglnpy Active_y

Option set with the following active options: y.

Active_y_long

public static final SedOptionSet_Iglnpy Active_y_long

Option set with the following active options: y.

Field Detail

g

public final SedOptionSet_Iglnpy g

Option "-g": Globally substitute for all non-overlapping instances of the regexp rather than just the first one.

(This option is ignored if the occurrence operand is specified).

The option "-g" is equivalent to the "--global" option.

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

global

public final SedOptionSet_Iglnpy global

Option "--global": Globally substitute for all non-overlapping instances of the regexp rather than just the first one.

(This option is ignored if the occurrence operand is specified).

The option "--global" is equivalent to the "-g" option.

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

I

public final SedOptionSet_Iglnpy I

Option "-I": Use case insensitive pattern matching.

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

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

ignoreCase

public final SedOptionSet_Iglnpy ignoreCase

Option "--ignoreCase": Use case insensitive pattern matching.

The option "--ignoreCase" is equivalent to the "-I" 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.

l

public final SedOptionSet_Iglnpy l

Option "-l": Writes the current line number on a separate line to the standard output.

The option "-l" is equivalent to the "--lineNumber" option.

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

lineNumber

public final SedOptionSet_Iglnpy lineNumber

Option "--lineNumber": Writes the current line number on a separate line to the standard output.

The option "--lineNumber" is equivalent to the "-l" option.

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

p

public final SedOptionSet_Iglnpy p

Option "-p": Write the matched line to standard output.

The option "-p" is equivalent to the "--print" option.

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

print

public final SedOptionSet_Iglnpy print

Option "--print": Write the matched line to standard output.

The option "--print" is equivalent to the "-p" option.

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

n

public final SedOptionSet_Iglnpy n

Option "-n": Suppress the default output (in which each line, after it is examined for editing, is written to standard output). Only lines explicitly selected for output are written.

The option "-n" is equivalent to the "--quiet" option.

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

quiet

public final SedOptionSet_Iglnpy quiet

Option "--quiet": Suppress the default output (in which each line, after it is examined for editing, is written to standard output). Only lines explicitly selected for output are written.

The option "--quiet" is equivalent to the "-n" option.

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

y

public final SedOptionSet_Iglnpy y

Option "-y": Replace all occurrences of characters in string1 with the corresponding characters in string2. If the number of characters in the two strings are not equal, or if any of the characters in string1 appear more than once, the results are undefined.

The option "-y" is equivalent to the "--translate" option.

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

translate

public final SedOptionSet_Iglnpy translate

Option "--translate": Replace all occurrences of characters in string1 with the corresponding characters in string2. If the number of characters in the two strings are not equal, or if any of the characters in string1 appear more than once, the results are undefined.

The option "--translate" is equivalent to the "-y" option.

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

Method Detail

values

public static SedOptionSet_Iglnpy[] 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 (SedOptionSet_Iglnpy c : SedOptionSet_Iglnpy.values())
    System.out.println(c);

Returns:

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

valueOf

public static SedOptionSet_Iglnpy 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<SedOption> optionType()

Description copied from interface: OptionSet

Returns the option type class, usually an enum.

Specified by:

optionType in interface OptionSet<SedOption>

Returns:

the option type

isSet

public boolean isSet(SedOption option)

Description copied from interface: OptionSet

Returns true if the specified option is set and false otherwise

Specified by:

isSet in interface OptionSet<SedOption>

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<SedOption>

Returns:

the number of active options

asSet

public EnumSet<SedOption> 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<SedOption>

Returns:

a copy of the set with the active options.

iterator

public Iterator<SedOption> iterator()

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

Specified by:

iterator in interface Iterable<SedOption>

Specified by:

iterator in interface OptionSet<SedOption>

Returns:

an immutable iterator for over the active options

useAcronymFor

public boolean useAcronymFor(SedOption 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

    SedOptionSet_Iglnpy.global.I;
 

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

    SedOptionSet_Iglnpy.g.ignoreCase;
 

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:

    SedOptionSet_Iglnpy.g.I.global;
 

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

Specified by:

useAcronymFor in interface OptionSet<SedOption>

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