net.sf.hajdbc.cache

Enum DatabaseMetaDataCacheFactoryClass

java.lang.Object

java.lang.Enum<DatabaseMetaDataCacheFactoryClass>

net.sf.hajdbc.cache.DatabaseMetaDataCacheFactoryClass

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DatabaseMetaDataCacheFactoryClass>, ClassEnum<DatabaseMetaDataCacheFactory>

public enum DatabaseMetaDataCacheFactoryClass
extends java.lang.Enum<DatabaseMetaDataCacheFactoryClass>
implements ClassEnum<DatabaseMetaDataCacheFactory>

Factory for creating DatabaseMetaDataCache implementations.

Since:

2.0

Author:

Paul Ferraro

Enum Constant Summary

Enum Constants

Enum Constant and Description
EAGER
LAZY
NONE

Method Summary

Modifier and Type	Method and Description
static DatabaseMetaDataCacheFactory	deserialize(java.lang.String id) Creates a new instance of the DatabaseMetaDataCacheFactory implementation identified by the specified identifier
boolean	isInstance(DatabaseMetaDataCacheFactory cache) Indicates whether the specified object is an instance of this enumerated class.
DatabaseMetaDataCacheFactory	newInstance() Creates a new instance of the enumerated class.
static java.lang.String	serialize(DatabaseMetaDataCacheFactory factory) Return the identifier of the specified DatabaseMetaDataCacheFactory.
static DatabaseMetaDataCacheFactoryClass	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DatabaseMetaDataCacheFactoryClass[]	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

NONE

public static final DatabaseMetaDataCacheFactoryClass NONE

LAZY

public static final DatabaseMetaDataCacheFactoryClass LAZY

EAGER

public static final DatabaseMetaDataCacheFactoryClass EAGER

Method Detail

values

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

Returns:

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

valueOf

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

isInstance

public boolean isInstance(DatabaseMetaDataCacheFactory cache)

Description copied from interface: ClassEnum

Indicates whether the specified object is an instance of this enumerated class.

Specified by:

isInstance in interface ClassEnum<DatabaseMetaDataCacheFactory>

Parameters:

cache - an instance

Returns:

true, if this object is an instance of this enumerated class, false otherwise

See Also:

ClassEnum.isInstance(java.lang.Object)

newInstance

public DatabaseMetaDataCacheFactory newInstance()
                                         throws java.lang.Exception

Description copied from interface: ClassEnum

Creates a new instance of the enumerated class.

Specified by:

newInstance in interface ClassEnum<DatabaseMetaDataCacheFactory>

Returns:

a new instance of the enumerated class

Throws:

java.lang.Exception - if a new instance could not be instantiated.

See Also:

ClassEnum.newInstance()

deserialize

public static DatabaseMetaDataCacheFactory deserialize(java.lang.String id)
                                                throws java.lang.Exception

Creates a new instance of the DatabaseMetaDataCacheFactory implementation identified by the specified identifier

Parameters:

id - an enumerated cache identifier

Returns:

a new cache factory instance

Throws:

java.lang.Exception - if specified cache identifier is invalid

serialize

public static java.lang.String serialize(DatabaseMetaDataCacheFactory factory)

Return the identifier of the specified DatabaseMetaDataCacheFactory.

Parameters:

factory - a cache factory implementation

Returns:

the class name of this cache