org.unix4j.unix.head

Enum HeadOption

java.lang.Object

java.lang.Enum<HeadOption>

org.unix4j.unix.head.HeadOption

All Implemented Interfaces:

Serializable, Comparable<HeadOption>, Iterable<HeadOption>, Option, OptionSet<HeadOption>, HeadOptions

public enum HeadOption
extends Enum<HeadOption>
implements Option, HeadOptions

Options for the head command.

For most applications, it may be more convenient to use Head.Options instead of the option constants defined here.

	-c		--chars		The count argument is in units of characters instead of lines. Starts from 1 and includes line ending characters.
	-q		--suppressHeaders		Suppresses printing of headers when multiple files are being examined.

Nested Class Summary

Nested classes/interfaces inherited from interface org.unix4j.unix.head.HeadOptions

HeadOptions.Default

Enum Constant Summary

Enum Constants

Enum Constant and Description
chars Option --chars, -c: The count argument is in units of characters instead of lines.
suppressHeaders Option --suppressHeaders, -q: Suppresses printing of headers when multiple files are being examined.

Field Summary

Fields inherited from interface org.unix4j.unix.head.HeadOptions

CONVERTER, EMPTY

Method Summary

Modifier and Type	Method and Description
char	acronym() Returns a one letter acronym for this option.
EnumSet<HeadOption>	asSet() Returns a new set with this active option.
static HeadOption	findByAcronym(char acronym) Returns the option with the given acronym, or null if no such option is found.
boolean	isSet(HeadOption option) Returns true if the specified option is set and false otherwise
Iterator<HeadOption>	iterator() Returns an immutable iterator returning o single element: this option.
Class<HeadOption>	optionType() Returns the option type class, usually an enum.
int	size() Returns 1 as this is a set with a single element: this option
boolean	useAcronymFor(HeadOption option) Returns true if the acronym should be used for the specified option in string representations.
static HeadOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static HeadOption[]	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 org.unix4j.option.Option

name

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Enum Constant Detail

chars

public static final HeadOption chars

Option --chars, -c: The count argument is in units of characters instead of lines. Starts from 1 and includes line ending characters.

suppressHeaders

public static final HeadOption suppressHeaders

Option --suppressHeaders, -q: Suppresses printing of headers when multiple files are being examined.

Method Detail

values

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

Returns:

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

valueOf

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

Description copied from interface: OptionSet

Returns the option type class, usually an enum.

Specified by:

optionType in interface OptionSet<HeadOption>

Returns:

the option type

findByAcronym

public static HeadOption findByAcronym(char acronym)

Returns the option with the given acronym, or null if no such option is found.

Parameters:

acronym - the option acronym

Returns:

the option with the given acronym or null if it is not found

acronym

public char acronym()

Description copied from interface: Option

Returns a one letter acronym for this option.

Specified by:

acronym in interface Option

Returns:

the acronym character used for this option.

isSet

public boolean isSet(HeadOption option)

Description copied from interface: OptionSet

Returns true if the specified option is set and false otherwise

Specified by:

isSet in interface OptionSet<HeadOption>

Parameters:

option - the option to test

Returns:

true if option is set in this OptionSet

asSet

public EnumSet<HeadOption> asSet()

Returns a new set with this active option.

Specified by:

asSet in interface OptionSet<HeadOption>

Returns:

a new set containing this option

iterator

public Iterator<HeadOption> iterator()

Returns an immutable iterator returning o single element: this option.

Specified by:

iterator in interface Iterable<HeadOption>

Specified by:

iterator in interface OptionSet<HeadOption>

Returns:

an immutable iterator with this active option.

size

public int size()

Returns 1 as this is a set with a single element: this option

Specified by:

size in interface OptionSet<HeadOption>

Returns:

one

useAcronymFor

public boolean useAcronymFor(HeadOption option)

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

This method returns always true for all options.

Specified by:

useAcronymFor in interface OptionSet<HeadOption>

Parameters:

option - the option of interest

Returns:

always true indicating that option acronyms should be used in string representations for all options