org.unix4j.unix.wc

Enum CounterType

java.lang.Object

java.lang.Enum<CounterType>

org.unix4j.unix.wc.CounterType

All Implemented Interfaces:

Serializable, Comparable<CounterType>

 enum CounterType
extends Enum<CounterType>

Constants for different count types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Chars
Lines
Words

Method Summary

Methods

Modifier and Type	Method and Description
abstract int	count(Line line) Returns the count by which a counter should be incremented given the specified line.
abstract boolean	isOptionSet(WcArguments args) Returns true if the option relevant for this count type is set in args.
static CounterType	valueOf(String name) Returns the enum constant of this type with the specified name.
static CounterType[]	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

Lines

public static final CounterType Lines

Words

public static final CounterType Words

Chars

public static final CounterType Chars

Method Detail

values

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

Returns:

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

valueOf

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

isOptionSet

public abstract boolean isOptionSet(WcArguments args)

Returns true if the option relevant for this count type is set in args.

Parameters:

args - the arguments with the count options

Returns:

true if this count type option is set

count

public abstract int count(Line line)

Returns the count by which a counter should be incremented given the specified line. For instance, the method returns 1 if this type specifies that lines are counted, and it returns the number of words or characters in the line if the count type refers to words or chars, respectively.

Parameters:

line - the line to analyse

Returns:

the increment to add to the counter for this count type and the specified line