com.google.enterprise.adaptor

Enum MetadataTransform.Keyset

java.lang.Object

java.lang.Enum<MetadataTransform.Keyset>

com.google.enterprise.adaptor.MetadataTransform.Keyset

All Implemented Interfaces:

Serializable, Comparable<MetadataTransform.Keyset>

Enclosing interface:

MetadataTransform

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

Identifies the location a configured key/value pair resides, either in the Metadata, or the map of params supplied to the transform method of a MetadataTransform.

Suppose a transform wishes to examine or modify the display URL, which is stored in the params. The transform's configuration might include:

 key=Display-URL
 keyset=params
 

If unspecified, the default value is METADATA.

Since:

4.1.4

Enum Constant Summary

Enum Constants

Enum Constant and Description
METADATA The key/value(s) reside in the Metadata.
PARAMS The key/value pair resides in the Map of params.

Method Summary

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

METADATA

public static final MetadataTransform.Keyset METADATA

The key/value(s) reside in the Metadata. This value's name is metadata.

PARAMS

public static final MetadataTransform.Keyset PARAMS

The key/value pair resides in the Map of params. This value's name is params.

Method Detail

values

public static MetadataTransform.Keyset[] 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.Keyset c : MetadataTransform.Keyset.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.Keyset 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.Keyset from(String name)

Returns a Keyset value with the given name, or the default value of METADATA if name is null.

Parameters:

name - the name of the Keyset value

Returns:

a Keyset corresponding to name

Throws:

IllegalArgumentException - if there is no Keyset value with name.

toString

public String toString()

Returns the name of this Keyset value.

Overrides:

toString in class Enum<MetadataTransform.Keyset>