org.unix4j.unix.sed

Enum Command

java.lang.Object

java.lang.Enum<Command>

org.unix4j.unix.sed.Command

All Implemented Interfaces:

Serializable, Comparable<Command>

public enum Command
extends Enum<Command>

Constants for the sed commands with utility method to derive a constant from a script (see fromScript(String) or from the sed arguments fromArgs(SedArguments). The constant also provides support for the instantiation of a new command processor through createProcessorFor(SedArguments, LineProcessor).

Enum Constant Summary

Enum Constants

Enum Constant and Description
append
change
delete
insert
print
substitute
translate

Field Summary

Fields

Modifier and Type	Field and Description
protected char	commandChar

Method Summary

Methods

Modifier and Type	Method and Description
abstract AbstractSedProcessor	createProcessorFor(SedArguments args, LineProcessor output) Returns a new instance of the appropriate sed processor for this command.
abstract AbstractSedProcessor	createProcessorFor(String script, SedArguments args, LineProcessor output) Returns a new instance of the appropriate sed processor for this command.
static Command	fromArgs(SedArguments args) Returns the command constant taken from the command option set in args using the matches(SedArguments) method Returns null if no command option is set.
static Command	fromScript(String script) Returns the command constant The first non-whitespace character of the script defines the command for substitute and translate; for all other commands, it is the first character after a whitespace sequence within the script (leading whitespace is ignored).
abstract boolean	matches(SedArguments args) Returns true if the the command option for this command is set in the specified sed arguments, and false otherwise.
static Command	valueOf(String name) Returns the enum constant of this type with the specified name.
static Command[]	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

print

public static final Command print

substitute

public static final Command substitute

append

public static final Command append

insert

public static final Command insert

change

public static final Command change

delete

public static final Command delete

translate

public static final Command translate

Field Detail

commandChar

protected final char commandChar

Method Detail

values

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

Returns:

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

valueOf

public static Command 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

matches

public abstract boolean matches(SedArguments args)

Returns true if the the command option for this command is set in the specified sed arguments, and false otherwise.

Parameters:

args - the sed arguments

Returns:

true if the command option for this command is set in args

createProcessorFor

public abstract AbstractSedProcessor createProcessorFor(SedArguments args,
                                      LineProcessor output)

Returns a new instance of the appropriate sed processor for this command. Note that this method does not check whether the correct command option is selected in args.

Parameters:

args - the sed arguments passed to the processor constructor

output - the output object passed to the processor constructor

Returns:

a new sed processor instance for this command

createProcessorFor

public abstract AbstractSedProcessor createProcessorFor(String script,
                                      SedArguments args,
                                      LineProcessor output)

Returns a new instance of the appropriate sed processor for this command. Note that this method does not check whether the script starts with the correct command character.

Parameters:

script - the sed script passed to the processor constructor

args - the sed arguments passed to the processor constructor

output - the output object passed to the processor constructor

Returns:

a new sed processor instance for this command

fromScript

public static Command fromScript(String script)

Returns the command constant The first non-whitespace character of the script defines the command for substitute and translate; for all other commands, it is the first character after a whitespace sequence within the script (leading whitespace is ignored).

Parameters:

script - the script to analyse

Returns:

the matching command or null if not found

fromArgs

public static Command fromArgs(SedArguments args)

Returns the command constant taken from the command option set in args using the matches(SedArguments) method Returns null if no command option is set.

Parameters:

args - the sed command arguments

Returns:

the matching command or null if not found