com.exsoinn.util.epf

Enum ContextFactory

java.lang.Object

java.lang.Enum<ContextFactory>

com.exsoinn.util.epf.ContextFactory

All Implemented Interfaces:

Serializable, Comparable<ContextFactory>

public enum ContextFactory
extends Enum<ContextFactory>

Factory for building Context's from passed in data. Currently any valid JSON or XML string can be converted to a Context. TODO: Enhance to suppert Nashorn ECMA JSON objects, do what client code does not have to do JSON.stringify() on those??? Created by QuijadaJ on 5/3/2017.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
static Context	obtainContext(Object pData) Factory method which will attempt to return a Context by inspecting the passed in pData.
static MutableContext	obtainMutableContext(Object pData) Sames as obtainContext(Object), but returns ab object of type MutableContext.
static ContextFactory	valueOf(String name) Returns the enum constant of this type with the specified name.
static ContextFactory[]	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 ContextFactory INSTANCE

Method Detail

values

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

Returns:

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

valueOf

public static ContextFactory valueOf(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:

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

NullPointerException - if the argument is null

obtainContext

public static Context obtainContext(Object pData)
                             throws IllegalArgumentException

Factory method which will attempt to return a Context by inspecting the passed in pData. The pData passed in must be in a format that will be recognized, otherwise IllegalArgumentException exception gets thrown. At this time only JSON format is supported, and the JSON is built by relying on Google JSON API. Plans are to add support for XML format using a similar, already existing 3rd party XML API.

Parameters:

pData - - The data from which a Context will be constructed.

Returns:

- Data of some format wrapped inside a Context object.

Throws:

IllegalArgumentException - - TODO

obtainMutableContext

public static MutableContext obtainMutableContext(Object pData)
                                           throws IllegalArgumentException

Sames as obtainContext(Object), but returns ab object of type MutableContext.

Parameters:

pData - - pData

Returns:

- TODO

Throws:

IllegalArgumentException - - TODO