com.google.enterprise.adaptor

Enum MetadataTransform.TransmissionDecision

java.lang.Object

java.lang.Enum<MetadataTransform.TransmissionDecision>

com.google.enterprise.adaptor.MetadataTransform.TransmissionDecision

All Implemented Interfaces:

Serializable, Comparable<MetadataTransform.TransmissionDecision>

Enclosing interface:

MetadataTransform

public static enum MetadataTransform.TransmissionDecision
extends Enum<MetadataTransform.TransmissionDecision>

Transforms can cancel sending a document, or cancel sending its contents by adding a Transmission-Decision to the Map of params supplied to the transform method of the MetadataTransform. If no Transmission-Decision is set in the params, the default value of AS_IS is used.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AS_IS The document's metadata and content are to remain intact.
DO_NOT_INDEX The document's metadata and content are discarded.
DO_NOT_INDEX_CONTENT The document's content is discarded, but its metadata remains intact.

Method Summary

Modifier and Type	Method and Description
static MetadataTransform.TransmissionDecision	from(String name) Returns a TransmissionDecision value with the given name, or the default value of AS_IS if name is null.
String	toString() Returns the name of this TransmissionDecision value.
static MetadataTransform.TransmissionDecision	valueOf(String name) Returns the enum constant of this type with the specified name.
static MetadataTransform.TransmissionDecision[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AS_IS

public static final MetadataTransform.TransmissionDecision AS_IS

The document's metadata and content are to remain intact. This value's name is as-is.

DO_NOT_INDEX

public static final MetadataTransform.TransmissionDecision DO_NOT_INDEX

The document's metadata and content are discarded. This value's name is do-not-index.

DO_NOT_INDEX_CONTENT

public static final MetadataTransform.TransmissionDecision DO_NOT_INDEX_CONTENT

The document's content is discarded, but its metadata remains intact. This value's name is do-not-index-content.

Method Detail

values

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

Returns:

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

valueOf

public static MetadataTransform.TransmissionDecision 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

from

public static MetadataTransform.TransmissionDecision from(String name)

Returns a TransmissionDecision value with the given name, or the default value of AS_IS if name is null.

Parameters:

name - the name of the TransmissionDecision value

Returns:

a TransmissionDecision corresponding to name

Throws:

IllegalArgumentException - if there is no TransmissionDecision value with name.

toString

public String toString()

Returns the name of this TransmissionDecision value.

Overrides:

toString in class Enum<MetadataTransform.TransmissionDecision>