Package com.clover.sdk.v3.base
Class IdArray
- java.lang.Object
-
- com.clover.sdk.GenericParcelable
-
- com.clover.sdk.v3.base.IdArray
-
- All Implemented Interfaces:
Parcelable
,JSONifiable
,Validator
public class IdArray extends GenericParcelable implements Validator, JSONifiable
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
IdArray.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 extends Object>, Parcelable.Creator<T extends Object>
-
-
Field Summary
Fields Modifier and Type Field Description static Parcelable.Creator<IdArray>
CREATOR
static JSONifiable.Creator<IdArray>
JSON_CREATOR
-
Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
-
-
Constructor Summary
Constructors Modifier Constructor Description IdArray()
Constructs a new empty instance.protected
IdArray(boolean noInit)
Constructs a new empty instance.IdArray(IdArray src)
Constructs a new instance that is a deep copy of the source instance.IdArray(String json)
Constructs a new instance from the given JSON String.IdArray(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.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clearIds()
Clears the 'ids' field, the 'has' method for this field will now return falseboolean
containsChanges()
Returns true if this instance has any changes.IdArray
copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.protected GenericClient
getGenericClient()
List<Reference>
getIds()
List of idsJSONObject
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
hasIds()
Checks whether the 'ids' field has been set, however the value could be nullboolean
isNotEmptyIds()
Checks whether the 'ids' field is set and is not null and is not emptyboolean
isNotNullIds()
Checks whether the 'ids' field is set and is not nullvoid
mergeChanges(IdArray 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.IdArray
setIds(List<Reference> ids)
Sets the field 'ids'.void
validate()
-
Methods inherited from class com.clover.sdk.GenericParcelable
describeContents, getBundle, toString, writeToParcel
-
-
-
-
Field Detail
-
CREATOR
public static final Parcelable.Creator<IdArray> CREATOR
-
JSON_CREATOR
public static final JSONifiable.Creator<IdArray> JSON_CREATOR
-
-
Constructor Detail
-
IdArray
public IdArray()
Constructs a new empty instance.
-
IdArray
protected IdArray(boolean noInit)
Constructs a new empty instance.
-
IdArray
public IdArray(String json) throws IllegalArgumentException
Constructs a new instance from the given JSON String.- Throws:
IllegalArgumentException
-
IdArray
public IdArray(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.
-
IdArray
public IdArray(IdArray src)
Constructs a new instance that is a deep copy of the source instance. It does not copy the bundle or changelog.
-
-
Method Detail
-
getGenericClient
protected GenericClient getGenericClient()
- Specified by:
getGenericClient
in classGenericParcelable
-
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 interfaceJSONifiable
-
isNotNullIds
public boolean isNotNullIds()
Checks whether the 'ids' field is set and is not null
-
isNotEmptyIds
public boolean isNotEmptyIds()
Checks whether the 'ids' field is set and is not null and is not empty
-
hasIds
public boolean hasIds()
Checks whether the 'ids' field has been set, however the value could be null
-
setIds
public IdArray setIds(List<Reference> ids)
Sets the field 'ids'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.
-
clearIds
public void clearIds()
Clears the 'ids' 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 IdArray copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.
-
mergeChanges
public void mergeChanges(IdArray src)
Copy all the changed fields from the given source to this instance.
-
-