Package com.hellosign.sdk.resource

Class AbstractResource

java.lang.Object

com.hellosign.sdk.resource.AbstractResource

Direct Known Subclasses:

AbstractRequest, AbstractResourceList, Account, ApiApp, ApiAppOauth, BulkSendJobById, BulkSendJobs, CustomField, Document, EmbeddedResponse, Event, FileUrlResponse, Metadata, OauthData, Quotas, ResponseData, Signature, Team, Template, TemplateRole, Warning, WhiteLabelingOptions

public abstract class AbstractResource
extends java.lang.Object

A nice place to put code that is common to all HelloSign resource classes.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.json.JSONObject	dataObj
protected java.util.List<Warning>	warnings

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractResource()
protected	AbstractResource(org.json.JSONObject json, java.lang.String optionalKey)

Method Summary

Modifier and Type	Method	Description
protected <T> void	add(java.lang.String key, T item)
protected void	addToList(java.lang.String key, AbstractResource listItem)
protected void	clearList(java.lang.String key)
protected java.lang.Object	get(java.lang.String key)
protected java.lang.Boolean	getBoolean(java.lang.String key)
protected java.lang.reflect.Constructor<?>	getConstructor(java.lang.Class<?> clazz, java.lang.Class<?> paramClass)	Returns the first constructor that has exactly one parameter of the provided paramClass type.
protected java.util.Date	getDate(java.lang.String key)
protected java.lang.Integer	getInteger(java.lang.String key)
org.json.JSONObject	getJSONObject()
protected <T> java.util.List<T>	getList(java.lang.Class<T> clazz, java.lang.String key)
protected <T> java.util.List<T>	getList(java.lang.Class<T> clazz, java.lang.String key, java.io.Serializable filterValue, java.lang.String filterColumnName)
protected java.lang.Long	getLong(java.lang.String key)
protected <T> java.lang.Object	getObject(java.lang.Class<T> Class, java.lang.Object obj, java.lang.String key)	Get Type castable object.
protected java.lang.String	getString(java.lang.String key)
java.util.List<Warning>	getWarnings()
protected boolean	has(java.lang.String key)
protected static boolean	hasString(java.lang.String s)
protected void	set(java.lang.String key, java.lang.Object value)
java.lang.String	toString()
java.lang.String	toString(int spacesToIndent)

Methods inherited from class java.lang.Object

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

Field Detail

dataObj

protected org.json.JSONObject dataObj

warnings

protected java.util.List<Warning> warnings

Constructor Detail

AbstractResource

protected AbstractResource()

AbstractResource

protected AbstractResource(org.json.JSONObject json,
                           java.lang.String optionalKey)
                    throws HelloSignException

Throws:

HelloSignException

Method Detail

hasString

protected static boolean hasString(java.lang.String s)

getJSONObject

public org.json.JSONObject getJSONObject()

has

protected boolean has(java.lang.String key)

set

protected void set(java.lang.String key,
                   java.lang.Object value)

getString

protected java.lang.String getString(java.lang.String key)

getBoolean

protected java.lang.Boolean getBoolean(java.lang.String key)

getInteger

protected java.lang.Integer getInteger(java.lang.String key)

get

protected java.lang.Object get(java.lang.String key)

getDate

protected java.util.Date getDate(java.lang.String key)

getLong

protected java.lang.Long getLong(java.lang.String key)

getList

protected <T> java.util.List<T> getList(java.lang.Class<T> clazz,
                                        java.lang.String key)

getObject

protected <T> java.lang.Object getObject(java.lang.Class<T> Class,
                                         java.lang.Object obj,
                                         java.lang.String key)

Get Type castable object.

Type Parameters:

T - Object

Parameters:

Class - Pass Class type to be type casted.

obj - Provide Object needs to be type casted.

key - Key for Object.

getList

protected <T> java.util.List<T> getList(java.lang.Class<T> clazz,
                                        java.lang.String key,
                                        java.io.Serializable filterValue,
                                        java.lang.String filterColumnName)

clearList

protected void clearList(java.lang.String key)
                  throws HelloSignException

Throws:

HelloSignException

addToList

protected void addToList(java.lang.String key,
                         AbstractResource listItem)
                  throws HelloSignException

Throws:

HelloSignException

getConstructor

protected java.lang.reflect.Constructor<?> getConstructor(java.lang.Class<?> clazz,
                                                          java.lang.Class<?> paramClass)

Returns the first constructor that has exactly one parameter of the provided paramClass type.

Parameters:

clazz - Class whose constructors we are checking

paramClass - Class Parameter class that the constructor should take

Returns:

Constructor

add

protected <T> void add(java.lang.String key,
                       T item)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(int spacesToIndent)

getWarnings

public java.util.List<Warning> getWarnings()