Package com.clover.sdk.v3.base
Class Signature
- java.lang.Object
-
- com.clover.sdk.GenericParcelable
-
- com.clover.sdk.v3.base.Signature
-
- All Implemented Interfaces:
Parcelable
,JSONifiable
,Validator
public class Signature extends GenericParcelable implements Validator, JSONifiable
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Signature.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<Signature>
CREATOR
static JSONifiable.Creator<Signature>
JSON_CREATOR
-
Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
-
-
Constructor Summary
Constructors Modifier Constructor Description Signature()
Constructs a new empty instance.protected
Signature(boolean noInit)
Constructs a new empty instance.Signature(Signature src)
Constructs a new instance that is a deep copy of the source instance.Signature(String json)
Constructs a new instance from the given JSON String.Signature(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
clearHeight()
Clears the 'height' field, the 'has' method for this field will now return falsevoid
clearStrokes()
Clears the 'strokes' field, the 'has' method for this field will now return falsevoid
clearWidth()
Clears the 'width' field, the 'has' method for this field will now return falseboolean
containsChanges()
Returns true if this instance has any changes.Signature
copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.protected GenericClient
getGenericClient()
Integer
getHeight()
The pixel height of the signatureJSONObject
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.List<Points>
getStrokes()
A series of strokes representing a signatureInteger
getWidth()
The pixel width of the signatureboolean
hasHeight()
Checks whether the 'height' field has been set, however the value could be nullboolean
hasStrokes()
Checks whether the 'strokes' field has been set, however the value could be nullboolean
hasWidth()
Checks whether the 'width' field has been set, however the value could be nullboolean
isNotEmptyStrokes()
Checks whether the 'strokes' field is set and is not null and is not emptyboolean
isNotNullHeight()
Checks whether the 'height' field is set and is not nullboolean
isNotNullStrokes()
Checks whether the 'strokes' field is set and is not nullboolean
isNotNullWidth()
Checks whether the 'width' field is set and is not nullvoid
mergeChanges(Signature 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.Signature
setHeight(Integer height)
Sets the field 'height'.Signature
setStrokes(List<Points> strokes)
Sets the field 'strokes'.Signature
setWidth(Integer width)
Sets the field 'width'.void
validate()
-
Methods inherited from class com.clover.sdk.GenericParcelable
describeContents, getBundle, toString, writeToParcel
-
-
-
-
Field Detail
-
CREATOR
public static final Parcelable.Creator<Signature> CREATOR
-
JSON_CREATOR
public static final JSONifiable.Creator<Signature> JSON_CREATOR
-
-
Constructor Detail
-
Signature
public Signature()
Constructs a new empty instance.
-
Signature
protected Signature(boolean noInit)
Constructs a new empty instance.
-
Signature
public Signature(String json) throws IllegalArgumentException
Constructs a new instance from the given JSON String.- Throws:
IllegalArgumentException
-
Signature
public Signature(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.
-
Signature
public Signature(Signature src)
Constructs a new instance that is a deep copy of the source instance. It does not copy the bundle or changelog.
-
-
Method Detail
-
getWidth
public Integer getWidth()
The pixel width of the signature
-
getHeight
public Integer getHeight()
The pixel height of the signature
-
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
-
isNotNullStrokes
public boolean isNotNullStrokes()
Checks whether the 'strokes' field is set and is not null
-
isNotEmptyStrokes
public boolean isNotEmptyStrokes()
Checks whether the 'strokes' field is set and is not null and is not empty
-
isNotNullWidth
public boolean isNotNullWidth()
Checks whether the 'width' field is set and is not null
-
isNotNullHeight
public boolean isNotNullHeight()
Checks whether the 'height' field is set and is not null
-
hasStrokes
public boolean hasStrokes()
Checks whether the 'strokes' field has been set, however the value could be null
-
hasWidth
public boolean hasWidth()
Checks whether the 'width' field has been set, however the value could be null
-
hasHeight
public boolean hasHeight()
Checks whether the 'height' field has been set, however the value could be null
-
setStrokes
public Signature setStrokes(List<Points> strokes)
Sets the field 'strokes'. Nulls in the given List are skipped. List parameter is copied, so it will not reflect any changes, but objects inside it will.
-
clearStrokes
public void clearStrokes()
Clears the 'strokes' field, the 'has' method for this field will now return false
-
clearWidth
public void clearWidth()
Clears the 'width' field, the 'has' method for this field will now return false
-
clearHeight
public void clearHeight()
Clears the 'height' 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 Signature copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.
-
mergeChanges
public void mergeChanges(Signature src)
Copy all the changed fields from the given source to this instance.
-
-