com.marklogic.hub

Enum DatabaseKind

java.lang.Object

java.lang.Enum<DatabaseKind>

com.marklogic.hub.DatabaseKind

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DatabaseKind>

public enum DatabaseKind
extends java.lang.Enum<DatabaseKind>

Public enumeration for the types of databases in MarkLogic that the DHF uses. databaseNames are the string representations of types. Throws an error if an invalid DatabaseKind is specified.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FINAL
FINAL_MODULES Deprecated.
FINAL_SCHEMAS
FINAL_TRIGGERS
JOB
MODULES
STAGING
STAGING_MODULES Deprecated.
STAGING_SCHEMAS
STAGING_TRIGGERS
TRACE Deprecated.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getName(DatabaseKind databaseKind) Validates the MarkLogic server to ensure compatibility with the hub
static DatabaseKind	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DatabaseKind[]	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

STAGING

public static final DatabaseKind STAGING

FINAL

public static final DatabaseKind FINAL

JOB

public static final DatabaseKind JOB

TRACE

@Deprecated
public static final DatabaseKind TRACE

Deprecated.

STAGING_SCHEMAS

public static final DatabaseKind STAGING_SCHEMAS

FINAL_SCHEMAS

public static final DatabaseKind FINAL_SCHEMAS

STAGING_TRIGGERS

public static final DatabaseKind STAGING_TRIGGERS

FINAL_TRIGGERS

public static final DatabaseKind FINAL_TRIGGERS

MODULES

public static final DatabaseKind MODULES

STAGING_MODULES

@Deprecated
public static final DatabaseKind STAGING_MODULES

Deprecated.

FINAL_MODULES

@Deprecated
public static final DatabaseKind FINAL_MODULES

Deprecated.

Method Detail

values

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

Returns:

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

valueOf

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

getName

public static java.lang.String getName(DatabaseKind databaseKind)

Validates the MarkLogic server to ensure compatibility with the hub

Parameters:

databaseKind - - the enum for the type of database

Returns:

string name of the database kind

Throws:

InvalidDBOperationError - if the database kind is not found in enumeration