org.apache.beam.sdk.io.fs

Enum EmptyMatchTreatment

java.lang.Object

java.lang.Enum<EmptyMatchTreatment>

org.apache.beam.sdk.io.fs.EmptyMatchTreatment

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EmptyMatchTreatment>

public enum EmptyMatchTreatment
extends java.lang.Enum<EmptyMatchTreatment>

Options for allowing or disallowing filepatterns that match no resources in FileSystems.match(java.util.List<java.lang.String>).

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALLOW Filepatterns matching no resources are allowed.
ALLOW_IF_WILDCARD Filepatterns matching no resources are allowed if the filepattern contains a glob wildcard character, and disallowed otherwise (i.e.
DISALLOW Filepatterns matching no resources are disallowed.

Method Summary

Modifier and Type	Method and Description
static EmptyMatchTreatment	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EmptyMatchTreatment[]	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

ALLOW

public static final EmptyMatchTreatment ALLOW

Filepatterns matching no resources are allowed. For such a filepattern, MatchResult.status() will be MatchResult.Status.OK and MatchResult.metadata() will return an empty list.

DISALLOW

public static final EmptyMatchTreatment DISALLOW

Filepatterns matching no resources are disallowed. For such a filepattern, MatchResult.status() will be MatchResult.Status.NOT_FOUND and MatchResult.metadata() will throw a FileNotFoundException.

ALLOW_IF_WILDCARD

public static final EmptyMatchTreatment ALLOW_IF_WILDCARD

Filepatterns matching no resources are allowed if the filepattern contains a glob wildcard character, and disallowed otherwise (i.e. if the filepattern specifies a single file).

Method Detail

values

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

Returns:

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

valueOf

public static EmptyMatchTreatment valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null