com.amazon.ask.util

Enum CustomUserAgent

java.lang.Object

java.lang.Enum<CustomUserAgent>

com.amazon.ask.util.CustomUserAgent

All Implemented Interfaces:

Serializable, Comparable<CustomUserAgent>

public enum CustomUserAgent
extends Enum<CustomUserAgent>

Enum holds the values of all the custom user agents that need to be appended to the base user agent.

Enum Constant Summary

Enum Constants

Enum Constant and Description
TEMPLATE_RESOLVER Template resolver's user agent.

Method Summary

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

TEMPLATE_RESOLVER

public static final CustomUserAgent TEMPLATE_RESOLVER

Template resolver's user agent.

Method Detail

values

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

Returns:

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

valueOf

public static CustomUserAgent 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

getUserAgent

public String getUserAgent()

Returns the user agent.

Returns:

userAgent.