org.unix4j.unix.sed

Enum SedOptionSet_Igilnp

java.lang.Object

java.lang.Enum<SedOptionSet_Igilnp>

org.unix4j.unix.sed.SedOptionSet_Igilnp

All Implemented Interfaces:

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

public enum SedOptionSet_Igilnp
extends Enum<SedOptionSet_Igilnp>
implements SedOptions

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

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_gi Option set with the following active options: g, i.
Active_gi_long Option set with the following active options: g, i.
Active_gil Option set with the following active options: g, i, l.
Active_gil_long Option set with the following active options: g, i, l.
Active_giln Option set with the following active options: g, i, l, n.
Active_giln_long Option set with the following active options: g, i, l, n.
Active_gilnp Option set with the following active options: g, i, l, p, n.
Active_gilnp_long Option set with the following active options: g, i, l, p, n.
Active_gilp Option set with the following active options: g, i, l, p.
Active_gilp_long Option set with the following active options: g, i, l, p.
Active_gin Option set with the following active options: g, i, n.
Active_gin_long Option set with the following active options: g, i, n.
Active_ginp Option set with the following active options: g, i, p, n.
Active_ginp_long Option set with the following active options: g, i, p, n.
Active_gip Option set with the following active options: g, i, p.
Active_gip_long Option set with the following active options: g, i, p.
Active_i Option set with the following active options: i.
Active_i_long Option set with the following active options: i.
Active_Igi Option set with the following active options: g, I, i.
Active_Igi_long Option set with the following active options: g, I, i.
Active_Igil Option set with the following active options: g, I, i, l.
Active_Igil_long Option set with the following active options: g, I, i, l.
Active_Igiln Option set with the following active options: g, I, i, l, n.
Active_Igiln_long Option set with the following active options: g, I, i, l, n.
Active_Igilnp Option set with the following active options: g, I, i, l, p, n.
Active_Igilnp_long Option set with the following active options: g, I, i, l, p, n.
Active_Igilp Option set with the following active options: g, I, i, l, p.
Active_Igilp_long Option set with the following active options: g, I, i, l, p.
Active_Igin Option set with the following active options: g, I, i, n.
Active_Igin_long Option set with the following active options: g, I, i, n.
Active_Iginp Option set with the following active options: g, I, i, p, n.
Active_Iginp_long Option set with the following active options: g, I, i, p, n.
Active_Igip Option set with the following active options: g, I, i, p.
Active_Igip_long Option set with the following active options: g, I, i, p.
Active_Ii Option set with the following active options: I, i.
Active_Ii_long Option set with the following active options: I, i.
Active_Iil Option set with the following active options: I, i, l.
Active_Iil_long Option set with the following active options: I, i, l.
Active_Iiln Option set with the following active options: I, i, l, n.
Active_Iiln_long Option set with the following active options: I, i, l, n.
Active_Iilnp Option set with the following active options: I, i, l, p, n.
Active_Iilnp_long Option set with the following active options: I, i, l, p, n.
Active_Iilp Option set with the following active options: I, i, l, p.
Active_Iilp_long Option set with the following active options: I, i, l, p.
Active_Iin Option set with the following active options: I, i, n.
Active_Iin_long Option set with the following active options: I, i, n.
Active_Iinp Option set with the following active options: I, i, p, n.
Active_Iinp_long Option set with the following active options: I, i, p, n.
Active_Iip Option set with the following active options: I, i, p.
Active_Iip_long Option set with the following active options: I, i, p.
Active_il Option set with the following active options: i, l.
Active_il_long Option set with the following active options: i, l.
Active_iln Option set with the following active options: i, l, n.
Active_iln_long Option set with the following active options: i, l, n.
Active_ilnp Option set with the following active options: i, l, p, n.
Active_ilnp_long Option set with the following active options: i, l, p, n.
Active_ilp Option set with the following active options: i, l, p.
Active_ilp_long Option set with the following active options: i, l, p.
Active_in Option set with the following active options: i, n.
Active_in_long Option set with the following active options: i, n.
Active_inp Option set with the following active options: i, p, n.
Active_inp_long Option set with the following active options: i, p, n.
Active_ip Option set with the following active options: i, p.
Active_ip_long Option set with the following active options: i, p.

Field Summary

Fields

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

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

public static final SedOptionSet_Igilnp Active_Igilnp

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

Active_Igilnp_long

public static final SedOptionSet_Igilnp Active_Igilnp_long

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

Active_gilnp

public static final SedOptionSet_Igilnp Active_gilnp

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

Active_gilnp_long

public static final SedOptionSet_Igilnp Active_gilnp_long

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

Active_Iginp

public static final SedOptionSet_Igilnp Active_Iginp

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

Active_Iginp_long

public static final SedOptionSet_Igilnp Active_Iginp_long

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

Active_Igiln

public static final SedOptionSet_Igilnp Active_Igiln

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

Active_Igiln_long

public static final SedOptionSet_Igilnp Active_Igiln_long

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

Active_Iilnp

public static final SedOptionSet_Igilnp Active_Iilnp

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

Active_Iilnp_long

public static final SedOptionSet_Igilnp Active_Iilnp_long

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

Active_Igilp

public static final SedOptionSet_Igilnp Active_Igilp

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

Active_Igilp_long

public static final SedOptionSet_Igilnp Active_Igilp_long

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

Active_ginp

public static final SedOptionSet_Igilnp Active_ginp

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

Active_ginp_long

public static final SedOptionSet_Igilnp Active_ginp_long

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

Active_giln

public static final SedOptionSet_Igilnp Active_giln

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

Active_giln_long

public static final SedOptionSet_Igilnp Active_giln_long

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

Active_Igin

public static final SedOptionSet_Igilnp Active_Igin

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

Active_Igin_long

public static final SedOptionSet_Igilnp Active_Igin_long

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

Active_ilnp

public static final SedOptionSet_Igilnp Active_ilnp

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

Active_ilnp_long

public static final SedOptionSet_Igilnp Active_ilnp_long

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

Active_Iinp

public static final SedOptionSet_Igilnp Active_Iinp

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

Active_Iinp_long

public static final SedOptionSet_Igilnp Active_Iinp_long

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

Active_Iiln

public static final SedOptionSet_Igilnp Active_Iiln

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

Active_Iiln_long

public static final SedOptionSet_Igilnp Active_Iiln_long

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

Active_gilp

public static final SedOptionSet_Igilnp Active_gilp

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

Active_gilp_long

public static final SedOptionSet_Igilnp Active_gilp_long

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

Active_Igip

public static final SedOptionSet_Igilnp Active_Igip

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

Active_Igip_long

public static final SedOptionSet_Igilnp Active_Igip_long

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

Active_Igil

public static final SedOptionSet_Igilnp Active_Igil

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

Active_Igil_long

public static final SedOptionSet_Igilnp Active_Igil_long

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

Active_Iilp

public static final SedOptionSet_Igilnp Active_Iilp

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

Active_Iilp_long

public static final SedOptionSet_Igilnp Active_Iilp_long

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

Active_gin

public static final SedOptionSet_Igilnp Active_gin

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

Active_gin_long

public static final SedOptionSet_Igilnp Active_gin_long

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

Active_inp

public static final SedOptionSet_Igilnp Active_inp

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

Active_inp_long

public static final SedOptionSet_Igilnp Active_inp_long

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

Active_iln

public static final SedOptionSet_Igilnp Active_iln

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

Active_iln_long

public static final SedOptionSet_Igilnp Active_iln_long

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

Active_Iin

public static final SedOptionSet_Igilnp Active_Iin

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

Active_Iin_long

public static final SedOptionSet_Igilnp Active_Iin_long

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

Active_gip

public static final SedOptionSet_Igilnp Active_gip

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

Active_gip_long

public static final SedOptionSet_Igilnp Active_gip_long

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

Active_gil

public static final SedOptionSet_Igilnp Active_gil

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

Active_gil_long

public static final SedOptionSet_Igilnp Active_gil_long

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

Active_Igi

public static final SedOptionSet_Igilnp Active_Igi

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

Active_Igi_long

public static final SedOptionSet_Igilnp Active_Igi_long

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

Active_ilp

public static final SedOptionSet_Igilnp Active_ilp

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

Active_ilp_long

public static final SedOptionSet_Igilnp Active_ilp_long

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

Active_Iip

public static final SedOptionSet_Igilnp Active_Iip

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

Active_Iip_long

public static final SedOptionSet_Igilnp Active_Iip_long

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

Active_Iil

public static final SedOptionSet_Igilnp Active_Iil

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

Active_Iil_long

public static final SedOptionSet_Igilnp Active_Iil_long

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

Active_in

public static final SedOptionSet_Igilnp Active_in

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

Active_in_long

public static final SedOptionSet_Igilnp Active_in_long

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

Active_gi

public static final SedOptionSet_Igilnp Active_gi

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

Active_gi_long

public static final SedOptionSet_Igilnp Active_gi_long

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

Active_ip

public static final SedOptionSet_Igilnp Active_ip

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

Active_ip_long

public static final SedOptionSet_Igilnp Active_ip_long

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

Active_il

public static final SedOptionSet_Igilnp Active_il

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

Active_il_long

public static final SedOptionSet_Igilnp Active_il_long

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

Active_Ii

public static final SedOptionSet_Igilnp Active_Ii

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

Active_Ii_long

public static final SedOptionSet_Igilnp Active_Ii_long

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

Active_i

public static final SedOptionSet_Igilnp Active_i

Option set with the following active options: i.

Active_i_long

public static final SedOptionSet_Igilnp Active_i_long

Option set with the following active options: i.

Field Detail

g

public final SedOptionSet_Igilnp 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_Igilnp 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_Igilnp 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_Igilnp 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.

i

public final SedOptionSet_Igilnp i

Option "-i": Insert string2 as a separate line before the matched line.

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

insert

public final SedOptionSet_Igilnp insert

Option "--insert": Insert string2 as a separate line before the matched line.

The option "--insert" is equivalent to the "-i" option.

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

l

public final SedOptionSet_Igilnp 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_Igilnp 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_Igilnp 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_Igilnp 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_Igilnp 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_Igilnp 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.

Method Detail

values

public static SedOptionSet_Igilnp[] 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_Igilnp c : SedOptionSet_Igilnp.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_Igilnp 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_Igilnp.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_Igilnp.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_Igilnp.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