com.clover.sdk.v3.base

Class Reference

java.lang.Object

com.clover.sdk.GenericParcelable

com.clover.sdk.v3.base.Reference

All Implemented Interfaces:

Parcelable, JSONifiable, Validator

public class Reference
extends GenericParcelable
implements Validator, JSONifiable

This is an auto-generated Clover data object.

Fields

• id

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Reference.Constraints

Nested classes/interfaces inherited from interface com.clover.sdk.JSONifiable

JSONifiable.Creator<T>

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<Reference>	CREATOR
static JSONifiable.Creator<Reference>	JSON_CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
	Reference() Constructs a new empty instance.
protected	Reference(boolean noInit) Constructs a new empty instance.
	Reference(JSONObject jsonObject) Construct a new instance backed by the given JSONObject, the parameter is not copied so changes to it will be reflected in this instance and vice-versa.
	Reference(Reference src) Constructs a new instance that is a deep copy of the source instance.
	Reference(String json) Constructs a new instance from the given JSON String.

Method Summary

Modifier and Type	Method and Description
void	clearId() Clears the 'id' field, the 'has' method for this field will now return false
boolean	containsChanges() Returns true if this instance has any changes.
Reference	copyChanges() Create a copy of this instance that contains only fields that were set after the constructor was called.
protected GenericClient	getGenericClient()
String	getId() Unique identifier
JSONObject	getJSONObject() Returns the internal JSONObject backing this instance, the return value is not a copy so changes to it will be reflected in this instance and vice-versa.
boolean	hasId() Checks whether the 'id' field has been set, however the value could be null
boolean	isNotNullId() Checks whether the 'id' field is set and is not null
void	mergeChanges(Reference src) Copy all the changed fields from the given source to this instance.
void	resetChangeLog() Reset the log of changes made to this instance, calling copyChanges() after this would return an empty instance.
Reference	setId(String id) Sets the field 'id'.
void	validate()

Methods inherited from class com.clover.sdk.GenericParcelable

describeContents, getBundle, toString, writeToParcel

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final Parcelable.Creator<Reference> CREATOR

JSON_CREATOR

public static final JSONifiable.Creator<Reference> JSON_CREATOR

Constructor Detail

Reference

public Reference()

Constructs a new empty instance.

Reference

protected Reference(boolean noInit)

Constructs a new empty instance.

Reference

public Reference(String json)
          throws IllegalArgumentException

Constructs a new instance from the given JSON String.

Throws:

IllegalArgumentException

Reference

public Reference(JSONObject jsonObject)

Construct a new instance backed by the given JSONObject, the parameter is not copied so changes to it will be reflected in this instance and vice-versa.

Reference

public Reference(Reference src)

Constructs a new instance that is a deep copy of the source instance. It does not copy the bundle or changelog.

Method Detail

getId

public String getId()

Unique identifier

getGenericClient

protected GenericClient getGenericClient()

Specified by:

getGenericClient in class GenericParcelable

getJSONObject

public JSONObject getJSONObject()

Returns the internal JSONObject backing this instance, the return value is not a copy so changes to it will be reflected in this instance and vice-versa.

Specified by:

getJSONObject in interface JSONifiable

validate

public void validate()

Specified by:

validate in interface Validator

isNotNullId

public boolean isNotNullId()

Checks whether the 'id' field is set and is not null

hasId

public boolean hasId()

Checks whether the 'id' field has been set, however the value could be null

setId

public Reference setId(String id)

Sets the field 'id'.

clearId

public void clearId()

Clears the 'id' field, the 'has' method for this field will now return false

containsChanges

public boolean containsChanges()

Returns true if this instance has any changes.

resetChangeLog

public void resetChangeLog()

Reset the log of changes made to this instance, calling copyChanges() after this would return an empty instance.

copyChanges

public Reference copyChanges()

Create a copy of this instance that contains only fields that were set after the constructor was called.

mergeChanges

public void mergeChanges(Reference src)

Copy all the changed fields from the given source to this instance.