com.hcl.domino.keep

Enum KeepFactorySource

java.lang.Object

java.lang.Enum<KeepFactorySource>

com.hcl.domino.keep.KeepFactorySource

All Implemented Interfaces:

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

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

Default instance of Keep factory, to be used in production mode. Contains all methods to retrieve configuration specific items

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE Singleton to keep global state

Method Summary

Modifier and Type	Method and Description
io.vertx.core.json.JsonObject	getConfig() Global place where to find configuration settings
io.vertx.core.json.JsonObject	getConfigEvenIfEmpty() Global place where to find configuration settings
KeepFactory	getCurrentFactory()
KeepFactorySource	overwriteFactory(KeepFactory factory) factoryType - Standard, Test or Custom
KeepFactorySource	reset() Return to the default factory, production or after test
KeepFactorySource	setConfig(io.vertx.core.json.JsonObject newConfig) Updates the configuration object
static KeepFactorySource	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static KeepFactorySource[]	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

INSTANCE

public static final KeepFactorySource INSTANCE

Singleton to keep global state

Method Detail

values

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

Returns:

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

valueOf

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

getConfig

public io.vertx.core.json.JsonObject getConfig()
                                        throws KeepExceptionServer

Global place where to find configuration settings

Returns:

the KEEP runtime configuration

Throws:

KeepExceptionServer

getConfigEvenIfEmpty

public io.vertx.core.json.JsonObject getConfigEvenIfEmpty()

Global place where to find configuration settings

Returns:

the KEEP runtime configuration

getCurrentFactory

public KeepFactory getCurrentFactory()

Returns:

the current factory

overwriteFactory

public KeepFactorySource overwriteFactory(KeepFactory factory)

factoryType - Standard, Test or Custom

Parameters:

factory -

• a Keep factory if called with custom

Returns:

fluent

reset

public KeepFactorySource reset()

Return to the default factory, production or after test

Returns:

fluent

setConfig

public KeepFactorySource setConfig(io.vertx.core.json.JsonObject newConfig)

Updates the configuration object

Parameters:

newConfig -

Returns:

fluent