Package org.jopensignature.sign
Class SignatureResult
- java.lang.Object
-
- org.jopensignature.sign.SignatureResult
-
public class SignatureResult extends java.lang.ObjectThe final signature result object defining the outcome of the signing process.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSignatureResult.State
-
Constructor Summary
Constructors Constructor Description SignatureResult(SignatureResult.State state, SignatureData result)Construct a final signature result object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SignatureDatagetData()Returns the associateddataobject for the completed signing process.SignatureResult.StategetState()Returns the final state of the signature process.
-
-
-
Constructor Detail
-
SignatureResult
public SignatureResult(SignatureResult.State state, SignatureData result)
Construct a final signature result object.- Parameters:
state- One ofSignatureResult.Stateresult- a requiredSignatureDataobject in the case ofSignatureResult.State.DONE, optional (null) otherwise.
-
-
Method Detail
-
getData
public SignatureData getData()
Returns the associateddataobject for the completed signing process. The value will be non null if thestateisSignatureResult.State.DONE. For the statesSignatureResult.State.FAILEDandSignatureResult.State.CANCELimplementations may choose to provide a result object but are not enforced to.- Returns:
- the
resultfor the signing process.
-
getState
public SignatureResult.State getState()
Returns the final state of the signature process. The resulting value defines the outcome of the signing process. For details about the specific states see the documentation ofSignatureResult.State.- Returns:
- the final state of the signature process.
-
-