org.eclipse.persistence.annotations
Enum TenantTableDiscriminatorType

java.lang.Object
  java.lang.Enum<TenantTableDiscriminatorType>
      org.eclipse.persistence.annotations.TenantTableDiscriminatorType

All Implemented Interfaces:

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

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

An enum that is used within the TenantTableDiscriminator annotation.

Author:

Guy Pelletier

Since:

EclipseLink 2.4

Enum Constant Summary

PREFIX
Apply the tenant table discriminator as a prefix to all multitenant tables.

SCHEMA
Apply the tenant table discriminator as a schema to all multitenant tables.

SUFFIX
Apply the tenant table discriminator as a suffix to all multitenant tables.

Method Summary

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

SCHEMA

public static final TenantTableDiscriminatorType SCHEMA

Apply the tenant table discriminator as a schema to all multitenant tables. NOTE: this strategy requires appropriate database provisioning.

SUFFIX

public static final TenantTableDiscriminatorType SUFFIX

Apply the tenant table discriminator as a suffix to all multitenant tables. This is the default strategy.

PREFIX

public static final TenantTableDiscriminatorType PREFIX

Apply the tenant table discriminator as a prefix to all multitenant tables.

Method Detail

values

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

Returns:

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

valueOf

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