com.marklogic.client.datamovement

Enum Forest.HostType

java.lang.Object

java.lang.Enum<Forest.HostType>

com.marklogic.client.datamovement.Forest.HostType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Forest.HostType>

Enclosing interface:

Forest

public static enum Forest.HostType
extends java.lang.Enum<Forest.HostType>

Enum containing the list of host types a forest can have.

FOREST_HOST - host type indicating the host associated with the forest in the MarkLogic server

REQUEST_HOST - host type indicating the request host with which we have created the client - host on the request header.

ALTERNATE_HOST - host type indicating the alternate host of the forest - the host of the e - node when this forest belongs to an d - node.

OPEN_REPLICA_HOST - host type indicating the replica host associated with the forest in the MarkLogic server

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALTERNATE_HOST
FOREST_HOST
OPEN_REPLICA_HOST
REQUEST_HOST

Method Summary

Modifier and Type	Method and Description
static Forest.HostType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Forest.HostType[]	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

FOREST_HOST

public static final Forest.HostType FOREST_HOST

REQUEST_HOST

public static final Forest.HostType REQUEST_HOST

ALTERNATE_HOST

public static final Forest.HostType ALTERNATE_HOST

OPEN_REPLICA_HOST

public static final Forest.HostType OPEN_REPLICA_HOST

Method Detail

values

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

Returns:

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

valueOf

public static Forest.HostType valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null