Package org.apache.orc

Enum Class DataMask.Standard

java.lang.Object

java.lang.Enum<DataMask.Standard>

org.apache.orc.DataMask.Standard

All Implemented Interfaces:

Serializable, Comparable<DataMask.Standard>, Constable

Enclosing interface:

DataMask

public static enum DataMask.Standard
extends Enum<DataMask.Standard>

The standard DataMasks can be created using this short cut. For example, DataMask.Standard.NULLIFY.build(schema) will build a nullify DataMask.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NULLIFY
REDACT
SHA256

Method Summary

Modifier and Type	Method	Description
DataMaskDescription	getDescription(String... params)	Build a DataMaskDescription given the name and a set of parameters.
String	getName()	Get the name of the predefined data mask.
static DataMask.Standard	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DataMask.Standard[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NULLIFY

public static final DataMask.Standard NULLIFY

REDACT

public static final DataMask.Standard REDACT

SHA256

public static final DataMask.Standard SHA256

Method Details

values

public static DataMask.Standard[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static DataMask.Standard valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

Get the name of the predefined data mask.

Returns:

the standard name

getDescription

public DataMaskDescription getDescription(String... params)

Build a DataMaskDescription given the name and a set of parameters.

Parameters:

params - the parameters

Returns:

a MaskDescription with the given parameters