org.unix4j.unix.sed

Enum SedOptionSet_Iglnps

java.lang.Object

java.lang.Enum<SedOptionSet_Iglnps>

org.unix4j.unix.sed.SedOptionSet_Iglnps

All Implemented Interfaces:

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

public enum SedOptionSet_Iglnps
extends Enum<SedOptionSet_Iglnps>
implements SedOptions

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

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_glnps Option set with the following active options: g, l, p, n, s.
Active_glnps_long Option set with the following active options: g, l, p, n, s.
Active_glns Option set with the following active options: g, l, n, s.
Active_glns_long Option set with the following active options: g, l, n, s.
Active_glps Option set with the following active options: g, l, p, s.
Active_glps_long Option set with the following active options: g, l, p, s.
Active_gls Option set with the following active options: g, l, s.
Active_gls_long Option set with the following active options: g, l, s.
Active_gnps Option set with the following active options: g, p, n, s.
Active_gnps_long Option set with the following active options: g, p, n, s.
Active_gns Option set with the following active options: g, n, s.
Active_gns_long Option set with the following active options: g, n, s.
Active_gps Option set with the following active options: g, p, s.
Active_gps_long Option set with the following active options: g, p, s.
Active_gs Option set with the following active options: g, s.
Active_gs_long Option set with the following active options: g, s.
Active_Iglnps Option set with the following active options: g, I, l, p, n, s.
Active_Iglnps_long Option set with the following active options: g, I, l, p, n, s.
Active_Iglns Option set with the following active options: g, I, l, n, s.
Active_Iglns_long Option set with the following active options: g, I, l, n, s.
Active_Iglps Option set with the following active options: g, I, l, p, s.
Active_Iglps_long Option set with the following active options: g, I, l, p, s.
Active_Igls Option set with the following active options: g, I, l, s.
Active_Igls_long Option set with the following active options: g, I, l, s.
Active_Ignps Option set with the following active options: g, I, p, n, s.
Active_Ignps_long Option set with the following active options: g, I, p, n, s.
Active_Igns Option set with the following active options: g, I, n, s.
Active_Igns_long Option set with the following active options: g, I, n, s.
Active_Igps Option set with the following active options: g, I, p, s.
Active_Igps_long Option set with the following active options: g, I, p, s.
Active_Igs Option set with the following active options: g, I, s.
Active_Igs_long Option set with the following active options: g, I, s.
Active_Ilnps Option set with the following active options: I, l, p, n, s.
Active_Ilnps_long Option set with the following active options: I, l, p, n, s.
Active_Ilns Option set with the following active options: I, l, n, s.
Active_Ilns_long Option set with the following active options: I, l, n, s.
Active_Ilps Option set with the following active options: I, l, p, s.
Active_Ilps_long Option set with the following active options: I, l, p, s.
Active_Ils Option set with the following active options: I, l, s.
Active_Ils_long Option set with the following active options: I, l, s.
Active_Inps Option set with the following active options: I, p, n, s.
Active_Inps_long Option set with the following active options: I, p, n, s.
Active_Ins Option set with the following active options: I, n, s.
Active_Ins_long Option set with the following active options: I, n, s.
Active_Ips Option set with the following active options: I, p, s.
Active_Ips_long Option set with the following active options: I, p, s.
Active_Is Option set with the following active options: I, s.
Active_Is_long Option set with the following active options: I, s.
Active_lnps Option set with the following active options: l, p, n, s.
Active_lnps_long Option set with the following active options: l, p, n, s.
Active_lns Option set with the following active options: l, n, s.
Active_lns_long Option set with the following active options: l, n, s.
Active_lps Option set with the following active options: l, p, s.
Active_lps_long Option set with the following active options: l, p, s.
Active_ls Option set with the following active options: l, s.
Active_ls_long Option set with the following active options: l, s.
Active_nps Option set with the following active options: p, n, s.
Active_nps_long Option set with the following active options: p, n, s.
Active_ns Option set with the following active options: n, s.
Active_ns_long Option set with the following active options: n, s.
Active_ps Option set with the following active options: p, s.
Active_ps_long Option set with the following active options: p, s.
Active_s Option set with the following active options: s.
Active_s_long Option set with the following active options: s.

Field Summary

Fields

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

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_Iglnps	valueOf(String name) Returns the enum constant of this type with the specified name.
static SedOptionSet_Iglnps[]	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_Iglnps

public static final SedOptionSet_Iglnps Active_Iglnps

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

Active_Iglnps_long

public static final SedOptionSet_Iglnps Active_Iglnps_long

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

Active_glnps

public static final SedOptionSet_Iglnps Active_glnps

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

Active_glnps_long

public static final SedOptionSet_Iglnps Active_glnps_long

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

Active_Ignps

public static final SedOptionSet_Iglnps Active_Ignps

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

Active_Ignps_long

public static final SedOptionSet_Iglnps Active_Ignps_long

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

Active_Iglns

public static final SedOptionSet_Iglnps Active_Iglns

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

Active_Iglns_long

public static final SedOptionSet_Iglnps Active_Iglns_long

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

Active_Ilnps

public static final SedOptionSet_Iglnps Active_Ilnps

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

Active_Ilnps_long

public static final SedOptionSet_Iglnps Active_Ilnps_long

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

Active_Iglps

public static final SedOptionSet_Iglnps Active_Iglps

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

Active_Iglps_long

public static final SedOptionSet_Iglnps Active_Iglps_long

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

Active_gnps

public static final SedOptionSet_Iglnps Active_gnps

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

Active_gnps_long

public static final SedOptionSet_Iglnps Active_gnps_long

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

Active_glns

public static final SedOptionSet_Iglnps Active_glns

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

Active_glns_long

public static final SedOptionSet_Iglnps Active_glns_long

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

Active_Igns

public static final SedOptionSet_Iglnps Active_Igns

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

Active_Igns_long

public static final SedOptionSet_Iglnps Active_Igns_long

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

Active_lnps

public static final SedOptionSet_Iglnps Active_lnps

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

Active_lnps_long

public static final SedOptionSet_Iglnps Active_lnps_long

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

Active_Inps

public static final SedOptionSet_Iglnps Active_Inps

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

Active_Inps_long

public static final SedOptionSet_Iglnps Active_Inps_long

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

Active_Ilns

public static final SedOptionSet_Iglnps Active_Ilns

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

Active_Ilns_long

public static final SedOptionSet_Iglnps Active_Ilns_long

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

Active_glps

public static final SedOptionSet_Iglnps Active_glps

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

Active_glps_long

public static final SedOptionSet_Iglnps Active_glps_long

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

Active_Igps

public static final SedOptionSet_Iglnps Active_Igps

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

Active_Igps_long

public static final SedOptionSet_Iglnps Active_Igps_long

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

Active_Igls

public static final SedOptionSet_Iglnps Active_Igls

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

Active_Igls_long

public static final SedOptionSet_Iglnps Active_Igls_long

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

Active_Ilps

public static final SedOptionSet_Iglnps Active_Ilps

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

Active_Ilps_long

public static final SedOptionSet_Iglnps Active_Ilps_long

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

Active_gns

public static final SedOptionSet_Iglnps Active_gns

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

Active_gns_long

public static final SedOptionSet_Iglnps Active_gns_long

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

Active_nps

public static final SedOptionSet_Iglnps Active_nps

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

Active_nps_long

public static final SedOptionSet_Iglnps Active_nps_long

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

Active_lns

public static final SedOptionSet_Iglnps Active_lns

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

Active_lns_long

public static final SedOptionSet_Iglnps Active_lns_long

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

Active_Ins

public static final SedOptionSet_Iglnps Active_Ins

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

Active_Ins_long

public static final SedOptionSet_Iglnps Active_Ins_long

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

Active_gps

public static final SedOptionSet_Iglnps Active_gps

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

Active_gps_long

public static final SedOptionSet_Iglnps Active_gps_long

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

Active_gls

public static final SedOptionSet_Iglnps Active_gls

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

Active_gls_long

public static final SedOptionSet_Iglnps Active_gls_long

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

Active_Igs

public static final SedOptionSet_Iglnps Active_Igs

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

Active_Igs_long

public static final SedOptionSet_Iglnps Active_Igs_long

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

Active_lps

public static final SedOptionSet_Iglnps Active_lps

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

Active_lps_long

public static final SedOptionSet_Iglnps Active_lps_long

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

Active_Ips

public static final SedOptionSet_Iglnps Active_Ips

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

Active_Ips_long

public static final SedOptionSet_Iglnps Active_Ips_long

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

Active_Ils

public static final SedOptionSet_Iglnps Active_Ils

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

Active_Ils_long

public static final SedOptionSet_Iglnps Active_Ils_long

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

Active_ns

public static final SedOptionSet_Iglnps Active_ns

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

Active_ns_long

public static final SedOptionSet_Iglnps Active_ns_long

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

Active_gs

public static final SedOptionSet_Iglnps Active_gs

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

Active_gs_long

public static final SedOptionSet_Iglnps Active_gs_long

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

Active_ps

public static final SedOptionSet_Iglnps Active_ps

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

Active_ps_long

public static final SedOptionSet_Iglnps Active_ps_long

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

Active_ls

public static final SedOptionSet_Iglnps Active_ls

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

Active_ls_long

public static final SedOptionSet_Iglnps Active_ls_long

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

Active_Is

public static final SedOptionSet_Iglnps Active_Is

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

Active_Is_long

public static final SedOptionSet_Iglnps Active_Is_long

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

Active_s

public static final SedOptionSet_Iglnps Active_s

Option set with the following active options: s.

Active_s_long

public static final SedOptionSet_Iglnps Active_s_long

Option set with the following active options: s.

Field Detail

g

public final SedOptionSet_Iglnps 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_Iglnps 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_Iglnps 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_Iglnps 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_Iglnps 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_Iglnps 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_Iglnps 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_Iglnps 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_Iglnps 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_Iglnps 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.

s

public final SedOptionSet_Iglnps s

Option "-s": Substitutes the replacement string for instances of the regexp in the matched line.

The characters "$0" appearing in the replacement are replaced by the line matching the regexp. The characters "$n", where n is a digit other than zero, are replaced by the text matched by the corresponding backreference expression (aka group). The special meaning of "$n" in this context can be suppressed by preceding it by a backslash.

A line can be split by substituting a newline ('\n') into it.

A substitution is considered to have been performed even if the replacement string is identical to the string that it replaces.

The option "-s" is equivalent to the "--substitute" option.

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

substitute

public final SedOptionSet_Iglnps substitute

Option "--substitute": Substitutes the replacement string for instances of the regexp in the matched line.

The characters "$0" appearing in the replacement are replaced by the line matching the regexp. The characters "$n", where n is a digit other than zero, are replaced by the text matched by the corresponding backreference expression (aka group). The special meaning of "$n" in this context can be suppressed by preceding it by a backslash.

A line can be split by substituting a newline ('\n') into it.

A substitution is considered to have been performed even if the replacement string is identical to the string that it replaces.

The option "--substitute" is equivalent to the "-s" option.

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

Method Detail

values

public static SedOptionSet_Iglnps[] 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_Iglnps c : SedOptionSet_Iglnps.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_Iglnps 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_Iglnps.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_Iglnps.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_Iglnps.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