com.endeca.infront.cartridge.model
Enum LinkBuilder.LinkType

java.lang.Object
  java.lang.Enum<LinkBuilder.LinkType>
      com.endeca.infront.cartridge.model.LinkBuilder.LinkType

All Implemented Interfaces:

Serializable, Comparable<LinkBuilder.LinkType>

Enclosing class:

LinkBuilder

public static enum LinkBuilder.LinkType
extends Enum<LinkBuilder.LinkType>

The types of links that the LinkBuilder supports.

Enum Constant Summary

ABSOLUTE
A link type that defines an absolute URL.

RELATIVE_AGG_RECORD
A link type that defines a relative URL with a record state of an aggregate record.

RELATIVE_NAV
A link type that defines a relative URL with a navigation state.

RELATIVE_RECORD
A link type that defines a relative URL with a record state.

Method Summary

String	toString()
static LinkBuilder.LinkType	valueOf(String name) Returns the enum constant of this type with the specified name.
static LinkBuilder.LinkType[]	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

ABSOLUTE

public static final LinkBuilder.LinkType ABSOLUTE

A link type that defines an absolute URL.

RELATIVE_NAV

public static final LinkBuilder.LinkType RELATIVE_NAV

A link type that defines a relative URL with a navigation state.

RELATIVE_RECORD

public static final LinkBuilder.LinkType RELATIVE_RECORD

A link type that defines a relative URL with a record state.

RELATIVE_AGG_RECORD

public static final LinkBuilder.LinkType RELATIVE_AGG_RECORD

A link type that defines a relative URL with a record state of an aggregate record.

Method Detail

values

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

Returns:

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

valueOf

public static LinkBuilder.LinkType 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

toString

public String toString()

Overrides:

toString in class Enum<LinkBuilder.LinkType>

Returns:

the string representation of the link type.