com.dpslink.notification.api.param

Class APIParamFactory

java.lang.Object

com.dpslink.notification.api.param.APIParamFactory

All Implemented Interfaces:

java.io.Serializable

public class APIParamFactory
extends java.lang.Object
implements java.io.Serializable

A factory for Notification Framework API parameter objects.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	APIParamFactory.Util An inner class that contains miscellaneous utility helper methods.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.ResourceBundle	cvOverrides A reference to the class override resource properties.
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Constructor and Description
APIParamFactory()

Method Summary

Modifier and Type	Method and Description
static <PARAMOBJ extends APIParam<?>> PARAMOBJ	getObject(java.lang.Class<PARAMOBJ> objcls) Returns the Notification Framework API parameter object for the given object class.
static <PARAMOBJ extends APIParam<?>> PARAMOBJ	getObject(java.lang.Class<PARAMOBJ> objcls, java.util.HashMap<java.lang.String,java.lang.Object> source) Returns the Notification Framework API parameter object for the given object class.
static <PARAMOBJ extends APIParam<?>> PARAMOBJ	getObject(java.lang.Class<PARAMOBJ> objcls, java.lang.String source) Returns the Notification Framework API parameter object for the given object class.
static APIParam<? extends APIParam<?>>	getObject(java.lang.String clsname) Returns the Notification Framework API parameter object for the given class name.
static APIParam<? extends APIParam<?>>	getObject(java.lang.String clsname, java.util.HashMap<java.lang.String,java.lang.Object> source) Returns the Notification Framework API parameter object for the given class name.
static APIParam<? extends APIParam<?>>	getObject(java.lang.String clsname, java.lang.String source) Returns the Notification Framework API parameter object for the given class name.
protected static java.lang.Class<? extends APIParam<?>>	getObjectClass(java.lang.String clsname) Returns the object class for the given class name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

cvOverrides

protected static java.util.ResourceBundle cvOverrides

A reference to the class override resource properties.

Constructor Detail

APIParamFactory

public APIParamFactory()

Method Detail

getObject

public static APIParam<? extends APIParam<?>> getObject(java.lang.String clsname)

Returns the Notification Framework API parameter object for the given class name. Allows for properties to be defined that indicate which class actually gets created for the class that is passed to the method.

Example:
paramobj.MyObject.class=com.dpslink.somepackage.YourObject
If MyObject.class is passed to this method, the class actually created would be YourObject. If no matching property exists for MyObject.class, then MyObject would be created.

Parameters:

clsname - (String) The class name for the desired object.

Returns:

ParameterObject - The parameter object or null if unable to create the requested object. If no object class is defined in properties, the object for the supplied class is created.

getObject

public static APIParam<? extends APIParam<?>> getObject(java.lang.String clsname,
                                                        java.util.HashMap<java.lang.String,java.lang.Object> source)

Returns the Notification Framework API parameter object for the given class name. Allows for properties to be defined that indicate which class actually gets created for the class that is passed to the method.

Example:
paramobj.MyObject.class=com.dpslink.somepackage.YourObject
If MyObject.class is passed to this method, the class actually created would be YourObject. If no matching property exists for MyObject.class, then MyObject would be created.

Parameters:

clsname - (String) The class name for the desired object.

source - (HashMap) A hash map of field names and values.

Returns:

ParameterObject - The parameter object or null if unable to create the requested object. If no object class is defined in properties, the object for the supplied class is created.

getObject

public static APIParam<? extends APIParam<?>> getObject(java.lang.String clsname,
                                                        java.lang.String source)

Returns the Notification Framework API parameter object for the given class name. Allows for properties to be defined that indicate which class actually gets created for the class that is passed to the method.

Example:
paramobj.MyObject.class=com.dpslink.somepackage.YourObject
If MyObject.class is passed to this method, the class actually created would be YourObject. If no matching property exists for MyObject.class, then MyObject would be created.

Parameters:

clsname - (String) The class name for the desired object.

source - (String) A string beginning with { (left brace) and ending with } (right brace).

Returns:

ParameterObject - The parameter object or null if unable to create the requested object. If no object class is defined in properties, the object for the supplied class is created.

getObject

public static <PARAMOBJ extends APIParam<?>> PARAMOBJ getObject(java.lang.Class<PARAMOBJ> objcls)

Returns the Notification Framework API parameter object for the given object class. Allows for properties to be defined that indicate which class actually gets created for the class that is passed to the method.

Example:
paramobj.MyObject.class=com.dpslink.somepackage.YourObject
If MyObject.class is passed to this method, the class actually created would be YourObject. If no matching property exists for MyObject.class, then MyObject would be created.

Type Parameters:

PARAMOBJ - The type of parameter object to return.

Parameters:

objcls - (Class) The class for the desired object.

Returns:

ParameterObject - The parameter object or null if unable to create the requested object. If no object class is defined in properties, the object for the supplied class is created.

getObject

public static <PARAMOBJ extends APIParam<?>> PARAMOBJ getObject(java.lang.Class<PARAMOBJ> objcls,
                                                                java.util.HashMap<java.lang.String,java.lang.Object> source)

Returns the Notification Framework API parameter object for the given object class. Allows for properties to be defined that indicate which class actually gets created for the class that is passed to the method.

Example:
paramobj.MyObject.class=com.dpslink.somepackage.YourObject
If MyObject.class is passed to this method, the class actually created would be YourObject. If no matching property exists for MyObject.class, then MyObject would be created.

Type Parameters:

PARAMOBJ - The type of parameter object to return.

Parameters:

objcls - (Class) The class for the desired object.

source - (HashMap) A hash map of field names and values.

Returns:

ParameterObject - The parameter object or null if unable to create the requested object. If no object class is defined in properties, the object for the supplied class is created.

getObject

public static <PARAMOBJ extends APIParam<?>> PARAMOBJ getObject(java.lang.Class<PARAMOBJ> objcls,
                                                                java.lang.String source)

Returns the Notification Framework API parameter object for the given object class. Allows for properties to be defined that indicate which class actually gets created for the class that is passed to the method.

Example:
paramobj.MyObject.class=com.dpslink.somepackage.YourObject
If MyObject.class is passed to this method, the class actually created would be YourObject. If no matching property exists for MyObject.class, then MyObject would be created.

Type Parameters:

PARAMOBJ - The type of parameter object to return.

Parameters:

objcls - (Class) The class for the desired object.

source - (String) A string beginning with { (left brace) and ending with } (right brace).

Returns:

ParameterObject - The parameter object or null if unable to create the requested object. If no object class is defined in properties, the object for the supplied class is created.

getObjectClass

protected static java.lang.Class<? extends APIParam<?>> getObjectClass(java.lang.String clsname)

Returns the object class for the given class name.

Parameters:

clsname - (String) The class name for the desired object class.

Returns:

Class - The object class or null if the class could not be determined.