Class CapturedSignature


  • public class CapturedSignature
    extends Object
    CapturedSignature
    • Constructor Detail

      • CapturedSignature

        public CapturedSignature()
    • Method Detail

      • areaSize

        public CapturedSignature areaSize​(AreaSize areaSize)
        areaSize
        Parameters:
        areaSize -
        Returns:
        the current CapturedSignature instance, allowing for method chaining
      • getAreaSize

        public AreaSize getAreaSize()
        Get areaSize
        Returns:
        areaSize
      • setAreaSize

        public void setAreaSize​(AreaSize areaSize)
        areaSize
        Parameters:
        areaSize -
      • signaturePoint

        public CapturedSignature signaturePoint​(List<Point> signaturePoint)
        Coordinates of a point where the pen changes direction or lift. Contain the Coordinates of a point of the written signature where the pen changes direction or lift where (X and Y). When the signer lifts the pen, both X and Y have the value FFFF.
        Parameters:
        signaturePoint - Coordinates of a point where the pen changes direction or lift. Contain the Coordinates of a point of the written signature where the pen changes direction or lift where (X and Y). When the signer lifts the pen, both X and Y have the value FFFF.
        Returns:
        the current CapturedSignature instance, allowing for method chaining
      • getSignaturePoint

        public List<Point> getSignaturePoint()
        Coordinates of a point where the pen changes direction or lift. Contain the Coordinates of a point of the written signature where the pen changes direction or lift where (X and Y). When the signer lifts the pen, both X and Y have the value FFFF.
        Returns:
        signaturePoint Coordinates of a point where the pen changes direction or lift. Contain the Coordinates of a point of the written signature where the pen changes direction or lift where (X and Y). When the signer lifts the pen, both X and Y have the value FFFF.
      • setSignaturePoint

        public void setSignaturePoint​(List<Point> signaturePoint)
        Coordinates of a point where the pen changes direction or lift. Contain the Coordinates of a point of the written signature where the pen changes direction or lift where (X and Y). When the signer lifts the pen, both X and Y have the value FFFF.
        Parameters:
        signaturePoint - Coordinates of a point where the pen changes direction or lift. Contain the Coordinates of a point of the written signature where the pen changes direction or lift where (X and Y). When the signer lifts the pen, both X and Y have the value FFFF.
      • includeNullValues

        public CapturedSignature includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.
      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.
      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
      • equals

        public boolean equals​(Object o)
        Return true if this CapturedSignature object is equal to o.
        Overrides:
        equals in class Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • getExplicitNulls

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.
      • fromJson

        public static CapturedSignature fromJson​(String jsonString)
                                          throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of CapturedSignature given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of CapturedSignature
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to CapturedSignature
      • toJson

        public String toJson()
                      throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of CapturedSignature to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException