com.dpslink.notification.api.param

Class APIParam<PARAMOBJ>

java.lang.Object

com.dpslink.notification.api.param.APIParam<PARAMOBJ>

All Implemented Interfaces:

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

Direct Known Subclasses:

FCustomer, FOrder, FOrderDetail, FPaymentDetail, FProduct, FRestockNotification, FSecurityProfile, FShipper, FShipSummary, FSiteInfo, FUser

public abstract class APIParam<PARAMOBJ>
extends java.lang.Object
implements java.lang.Comparable<PARAMOBJ>, java.io.Serializable

An abstract Notification Framework API parameter object definition. This is the class from which all parameter objects are derived. Provides default object functionality, plus method signatures for required object-specific functionality.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	ivHashCode The object's hash code.
protected java.lang.String[]	ivHashFlds The object's set of hash code field names.
protected org.json.JSONObject	ivObjFlds The object's field names and values.
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	APIParam() A constructor for the abstract object.
protected	APIParam(java.util.HashMap<java.lang.String,java.lang.Object> source) A constructor for the abstract object.
protected	APIParam(java.util.HashMap<java.lang.String,java.lang.Object> source, java.lang.String[] hashflds) A constructor for the abstract object.
protected	APIParam(java.lang.String source) A constructor for the abstract object.
protected	APIParam(java.lang.String source, java.lang.String[] hashflds) A constructor for the abstract object.

Method Summary

Modifier and Type	Method and Description
boolean	after(PARAMOBJ obj) Answers if this object is greater than the given object based on the object's compareTo method results.
boolean	before(PARAMOBJ obj) Answers if this object is less than the given object based on the object's compareTo method results.
int	compareTo(PARAMOBJ obj) Compares this object to the given object and determines if this object is less than, equal to or greater than the given object.
boolean	equals(java.lang.Object obj) Compares the given object to this object and determines if the two are equal.
java.lang.String[]	getHashFields() Returns this object's set of hash code field names.
org.json.JSONObject	getObjectFields() Returns this object's field names and values.
int	hashCode() Returns a hash code for this object based on the field names supplied on the constructor.
protected void	removeStringWhitespace() Removes whitespace from this object's string values.
protected abstract void	removeUnwantedFields() Removes unwanted fields from a JSON object or from an array of JSON objects.
protected void	removeUnwantedFields(java.lang.String arrname, java.lang.String[] fldnames) Removes unwanted fields from a JSON object or from an array of JSON objects.
void	setHashFields(java.lang.String[] hashFlds) Sets this object's set of hash code field names.
void	setObjectFields(org.json.JSONObject flds) Sets this object's field names and values.
java.lang.String	toJSONString() Returns a JSON formatted string of this object's fields and values.
java.lang.String	toString() Returns a JSON formatted string of this object's fields and values.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

ivObjFlds

protected org.json.JSONObject ivObjFlds

The object's field names and values.

ivHashFlds

protected java.lang.String[] ivHashFlds

The object's set of hash code field names.

ivHashCode

protected int ivHashCode

The object's hash code.

Constructor Detail

APIParam

protected APIParam()

A constructor for the abstract object. Initializes all field values to null. The object's hash code is zero.

APIParam

protected APIParam(java.util.HashMap<java.lang.String,java.lang.Object> source)

A constructor for the abstract object. Initializes field values based on the supplied hash map. The object's hash code is zero.

Parameters:

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

APIParam

protected APIParam(java.util.HashMap<java.lang.String,java.lang.Object> source,
                   java.lang.String[] hashflds)

A constructor for the abstract object. Initializes field values based on the supplied JSON text string.

Parameters:

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

hashflds - (String[]) The set of field names used to determine the object's hash code. If no fields names are supplied, the object's hash code is zero.

APIParam

protected APIParam(java.lang.String source)

A constructor for the abstract object. Initializes field values based on the supplied JSON text string. The object's hash code is zero.

Parameters:

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

APIParam

protected APIParam(java.lang.String source,
                   java.lang.String[] hashflds)

A constructor for the abstract object. Initializes field values based on the supplied JSON text string.

Parameters:

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

hashflds - (String[]) The set of field names used to determine the object's hash code. If no fields names are supplied, the object's hash code is zero.

Method Detail

compareTo

public int compareTo(PARAMOBJ obj)

Compares this object to the given object and determines if this object is less than, equal to or greater than the given object. Comparison is based on hash code fields that were defined in the object's constructor.

Specified by:

compareTo in interface java.lang.Comparable<PARAMOBJ>

Parameters:

obj - (PARAMOBJ) The object to compare with this object.

Returns:

int - The result of the comparison: a negative integer if less than, a positive integer if greater than, a zero if equal.

equals

public boolean equals(java.lang.Object obj)

Compares the given object to this object and determines if the two are equal. Equality is based on hash code fields that were defined in the object's constructor.

Overrides:

equals in class java.lang.Object

Parameters:

obj - (Object) The object to compare with this object.

Returns:

boolean - true if the specified object is equal to this object, otherwise false.

hashCode

public int hashCode()

Returns a hash code for this object based on the field names supplied on the constructor.

Overrides:

hashCode in class java.lang.Object

Returns:

int - The object's hash code.

after

public boolean after(PARAMOBJ obj)

Answers if this object is greater than the given object based on the object's compareTo method results.

Parameters:

obj - (PARAMOBJ) The object to compare to this object to.

Returns:

boolean - true if this object is greater than the given object, otherwise false.

before

public boolean before(PARAMOBJ obj)

Answers if this object is less than the given object based on the object's compareTo method results.

Parameters:

obj - (PARAMOBJ) The object to compare to this object to.

Returns:

boolean - true if this object is less than the given object, otherwise false.

getHashFields

public java.lang.String[] getHashFields()

Returns this object's set of hash code field names.

Returns:

String[] - The hash code field names.

setHashFields

public void setHashFields(java.lang.String[] hashFlds)

Sets this object's set of hash code field names.

Parameters:

hashFlds - (String[]) The hash code field names.

getObjectFields

public org.json.JSONObject getObjectFields()

Returns this object's field names and values.

Returns:

JSONObject - The field names and values.

setObjectFields

public void setObjectFields(org.json.JSONObject flds)

Sets this object's field names and values.

Parameters:

flds - (JSONObject) The field names and values.

toJSONString

public java.lang.String toJSONString()

Returns a JSON formatted string of this object's fields and values. Same as toString() method.

Returns:

String - The formatted string.

toString

public java.lang.String toString()

Returns a JSON formatted string of this object's fields and values. Same as toJSONString() method.

Overrides:

toString in class java.lang.Object

Returns:

String - The formatted string.

removeStringWhitespace

protected void removeStringWhitespace()

Removes whitespace from this object's string values. Automatically invoked by the constructors.

removeUnwantedFields

protected void removeUnwantedFields(java.lang.String arrname,
                                    java.lang.String[] fldnames)

Removes unwanted fields from a JSON object or from an array of JSON objects.

Parameters:

arrname - (String) The name of an array of objects or null if processing a top-level object.

fldnames - (String[]) An array of field names to remove

removeUnwantedFields

protected abstract void removeUnwantedFields()

Removes unwanted fields from a JSON object or from an array of JSON objects. Automatically invoked by the constructors.