HeadOptionSet_cq (unix4j 0.7-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<HeadOptionSet_cq>
- - org.unix4j.unix.head.HeadOptionSet_cq

All Implemented Interfaces:

Serializable, Comparable<HeadOptionSet_cq>, Iterable<HeadOption>, OptionSet<HeadOption>, HeadOptions
```
public enum HeadOptionSet_cq
extends Enum<HeadOptionSet_cq>
implements HeadOptions
```
Option sets for the head command with the following options: c, q.
Application code does normally not directly refer to this class; Head.Options should be used instead to specify command options. See also HeadOptions for more information.

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
`Active_c` Option set with the following active options: `c`.
`Active_c_long` Option set with the following active options: `c`.
`Active_cq` Option set with the following active options: `c`, `q`.
`Active_cq_long` Option set with the following active options: `c`, `q`.
`Active_q` Option set with the following active options: `q`.
`Active_q_long` Option set with the following active options: `q`.

Field Summary

Fields
Modifier and Type	Field and Description
`HeadOptionSet_cq`	`c` Option `"-c"`: The `count` argument is in units of characters instead of lines.
`HeadOptionSet_cq`	`chars` Option `"--chars"`: The `count` argument is in units of characters instead of lines.
`HeadOptionSet_cq`	`q` Option `"-q"`: Suppresses printing of headers when multiple files are being examined.
`HeadOptionSet_cq`	`suppressHeaders` Option `"--suppressHeaders"`: Suppresses printing of headers when multiple files are being examined.

Fields inherited from interface org.unix4j.unix.head.HeadOptions
CONVERTER, EMPTY

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EnumSet<HeadOption>`	`asSet()` Returns the set with the active options.
`boolean`	`isSet(HeadOption option)` Returns true if the specified `option` is set and false otherwise
`Iterator<HeadOption>`	`iterator()` Returns an immutable iterator with the active options of this option set.
`Class<HeadOption>`	`optionType()` Returns the option type class, usually an enum.
`int`	`size()` Returns the number of active options in this option set.
`boolean`	`useAcronymFor(HeadOption option)` Returns true if the `acronym` should be used in for the specified `option` string representations.
`static HeadOptionSet_cq`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static HeadOptionSet_cq[]`	`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_cq
```
public static final HeadOptionSet_cq Active_cq
```
    Option set with the following active options: c, q.
  - Active_cq_long
```
public static final HeadOptionSet_cq Active_cq_long
```
    Option set with the following active options: c, q.
  - Active_c
```
public static final HeadOptionSet_cq Active_c
```
    Option set with the following active options: c.
  - Active_c_long
```
public static final HeadOptionSet_cq Active_c_long
```
    Option set with the following active options: c.
  - Active_q
```
public static final HeadOptionSet_cq Active_q
```
    Option set with the following active options: q.
  - Active_q_long
```
public static final HeadOptionSet_cq Active_q_long
```
    Option set with the following active options: q.
- Field Detail
  - c
```
public final HeadOptionSet_cq c
```
    Option "-c": The count argument is in units of characters instead of lines. Starts from 1 and includes line ending characters.
    The option "-c" is equivalent to the "--chars" option.
    Technically speaking, this field points to a set with the options of the current set plus the option "-c". If the option "-c" is already set, the field c points to the enum constant itself as it already represents the current set of options.
  - chars
```
public final HeadOptionSet_cq chars
```
    Option "--chars": The count argument is in units of characters instead of lines. Starts from 1 and includes line ending characters.
    The option "--chars" is equivalent to the "-c" option.
    Technically speaking, this field points to a set with the options of the current set plus the option "--chars". If the option "--chars" is already set, the field chars points to the enum constant itself as it already represents the current set of options.
  - q
```
public final HeadOptionSet_cq q
```
    Option "-q": Suppresses printing of headers when multiple files are being examined.
    The option "-q" is equivalent to the "--suppressHeaders" option.
    Technically speaking, this field points to a set with the options of the current set plus the option "-q". If the option "-q" is already set, the field q points to the enum constant itself as it already represents the current set of options.
  - suppressHeaders
```
public final HeadOptionSet_cq suppressHeaders
```
    Option "--suppressHeaders": Suppresses printing of headers when multiple files are being examined.
    The option "--suppressHeaders" is equivalent to the "-q" option.
    Technically speaking, this field points to a set with the options of the current set plus the option "--suppressHeaders". If the option "--suppressHeaders" is already set, the field suppressHeaders points to the enum constant itself as it already represents the current set of options.
- Method Detail
  - values
```
public static HeadOptionSet_cq[] 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 (HeadOptionSet_cq c : HeadOptionSet_cq.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static HeadOptionSet_cq 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
  - 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
  - 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<HeadOption>
    
    Returns:
    
    the number of active options
  - asSet
```
public EnumSet<HeadOption> 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<HeadOption>
    
    Returns:
    
    a copy of the set with the active options.
  - iterator
```
public Iterator<HeadOption> iterator()
```
    Returns an immutable iterator with the active options of this option set.
    
    Specified by:
    
    iterator in interface Iterable<HeadOption>
    
    Specified by:
    
    iterator in interface OptionSet<HeadOption>
    
    Returns:
    
    an immutable iterator for over the active options
  - useAcronymFor
```
public boolean useAcronymFor(HeadOption 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
```
    HeadOptionSet_cq.chars.q;
 
```
    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
```
    HeadOptionSet_cq.c.suppressHeaders;
 
```
    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:
```
    HeadOptionSet_cq.c.q.chars;
 
```
    This method always returns true for the empty set with no active options.
    Specified by:
    
    useAcronymFor in interface OptionSet<HeadOption>
    
    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

Enum HeadOptionSet_cq

Nested Class Summary

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

Enum Constant Summary

Field Summary

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

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Enum Constant Detail

Active_cq

Active_cq_long

Active_c

Active_c_long

Active_q

Active_q_long

Field Detail

c

chars

q

suppressHeaders

Method Detail

values

valueOf

optionType

isSet

size

asSet

iterator

useAcronymFor