FileCardinalityWriteOption (Disq 0.3.8 API)

java.lang.Object
- java.lang.Enum<FileCardinalityWriteOption>
- - org.disq_bio.disq.FileCardinalityWriteOption

All Implemented Interfaces:

Serializable, Comparable<FileCardinalityWriteOption>, WriteOption
```
public enum FileCardinalityWriteOption
extends Enum<FileCardinalityWriteOption>
implements WriteOption
```
An option for configuring whether to write output in a single file, or multiple files.

Enum Constant Summary

Enum Constants
Enum Constant Description

MULTIPLE
Write multiple files in a directory specified by the path.

SINGLE
Write a single file specified by the path.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static FileCardinalityWriteOption`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static FileCardinalityWriteOption[]`	`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
  - SINGLE
```
public static final FileCardinalityWriteOption SINGLE
```
    Write a single file specified by the path.
  - MULTIPLE
```
public static final FileCardinalityWriteOption MULTIPLE
```
    Write multiple files in a directory specified by the path.
- Method Detail
  - values
```
public static FileCardinalityWriteOption[] 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 (FileCardinalityWriteOption c : FileCardinalityWriteOption.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static FileCardinalityWriteOption 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