Parameter (HID Approve SDK for Android (5.1.2.2))

java.lang.Object
- com.hidglobal.ia.service.beans.Parameter

All Implemented Interfaces:

Serializable, Cloneable
```
public class Parameter
extends Object
implements Serializable, Cloneable
```
Represents a parameter or option where the ID and value are enforced to be of type String.
A type and encoding attribute are also available to represent more complex data that is to be sent or received. These might be useful, for example, when transporting a complex binary object.
Example: For an ASN.1-encoded RSA private key the Parameter may be:
- type = "CRMF.EncryptedValue" (or an OID if available)
- encoding = "base64Binary"
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ENCODING_BASE64_BYTE_ARRAY` Indicates a base64-encoded byte array.
`static String`	`ENCODING_DEFAULT` Default encoding for a Parameter with no set encoding.
`static String`	`ENCODING_HEX_BYTE_ARRAY` Indicates a hex-encoded byte array.
`static String`	`ENCODING_NONE` The encoding type that indicates no specific encoding.
`static String`	`TYPE_BYTEARRAY` Indicates the value is natively a byte[].
`static String`	`TYPE_DEFAULT` Default type for a Parameter: "String".
`static String`	`TYPE_INTEGER` Indicates the value is natively an integer.
`static String`	`TYPE_LONG` Indicates the value is natively a long.
`static String`	`TYPE_STRING` Indicates the value is natively a String.

Constructor Summary

Constructors
Constructor and Description
`Parameter()` Constructor.
`Parameter(String id, char[] value)` Constructor.
`Parameter(String encoding, String id, String type, char[] value)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getEncoding()` Returns the encoding of the Parameter or "NONE" if not encoded.
`String`	`getId()` Returns this Parameter's identifier or null if not set.
`String`	`getType()` Returns the type of the Parameter.
`char[]`	`getValue()` Returns this Parameter's value or null if not set.
`int`	`hashCode()`
`void`	`reset()` Clear value
`void`	`setEncoding(String encoding)` Sets the encoding of the Parameter.
`void`	`setId(String id)` Sets the Parameter's identifier.
`void`	`setType(String type)` Sets the type of the Parameter.
`void`	`setValue(char[] value)` Sets the Parameter's value.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ENCODING_NONE
```
public static final String ENCODING_NONE
```
    The encoding type that indicates no specific encoding. This indicates the value is natively a String and is not encoded.
    
    See Also:
    
    Constant Field Values
  - ENCODING_BASE64_BYTE_ARRAY
```
public static final String ENCODING_BASE64_BYTE_ARRAY
```
    Indicates a base64-encoded byte array.
    
    See Also:
    
    Constant Field Values
  - ENCODING_HEX_BYTE_ARRAY
```
public static final String ENCODING_HEX_BYTE_ARRAY
```
    Indicates a hex-encoded byte array.
    
    See Also:
    
    Constant Field Values
  - ENCODING_DEFAULT
```
public static final String ENCODING_DEFAULT
```
    Default encoding for a Parameter with no set encoding.
    
    See Also:
    
    ENCODING_NONE, Constant Field Values
  - TYPE_BYTEARRAY
```
public static final String TYPE_BYTEARRAY
```
    Indicates the value is natively a byte[].
    
    See Also:
    
    Constant Field Values
  - TYPE_STRING
```
public static final String TYPE_STRING
```
    Indicates the value is natively a String.
    
    See Also:
    
    Constant Field Values
  - TYPE_LONG
```
public static final String TYPE_LONG
```
    Indicates the value is natively a long.
    
    See Also:
    
    Constant Field Values
  - TYPE_INTEGER
```
public static final String TYPE_INTEGER
```
    Indicates the value is natively an integer.
    
    See Also:
    
    Constant Field Values
  - TYPE_DEFAULT
```
public static final String TYPE_DEFAULT
```
    Default type for a Parameter: "String". This indicates the value is natively a String.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Parameter
```
public Parameter()
```
    Constructor.
  - Parameter
```
public Parameter(String id,
                 char[] value)
```
    Constructor.
    
    Parameters:
    
    id - the Parameter's identifier
    
    value - the Parameter's value
  - Parameter
```
public Parameter(String encoding,
                 String id,
                 String type,
                 char[] value)
```
    Constructor
    
    Parameters:
    
    encoding - the Parameter's encoding
    
    id - the Parameter's identifier
    
    type - the Parameter's type
    
    value - the Parameter's value
- Method Detail
  - getId
```
public String getId()
```
    Returns this Parameter's identifier or null if not set.
    
    Returns:
    
    this Parameter's identifier or null if not set
  - getValue
```
public char[] getValue()
```
    Returns this Parameter's value or null if not set.
    
    Returns:
    
    this Parameter's value or null if not set
  - setId
```
public void setId(String id)
```
    Sets the Parameter's identifier.
    
    Parameters:
    
    id - the Parameter's identifier
  - setValue
```
public void setValue(char[] value)
```
    Sets the Parameter's value.
    
    Parameters:
    
    value - the Parameter's value
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
    
    See Also:
    
    Object.equals(java.lang.Object)
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
    
    See Also:
    
    Object.hashCode()
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
    
    See Also:
    
    Object.clone()
  - getEncoding
```
public String getEncoding()
```
    Returns the encoding of the Parameter or "NONE" if not encoded.
    
    Returns:
    
    The encoding of the Parameter or "NONE" if not encoded.
  - setEncoding
```
public void setEncoding(String encoding)
```
    Sets the encoding of the Parameter. If not set, "NONE" is the default.
    
    Parameters:
    
    encoding - the encoding of the Parameter
  - getType
```
public String getType()
```
    Returns the type of the Parameter.
    
    Returns:
    
    The type of the Parameter.
  - setType
```
public void setType(String type)
```
    Sets the type of the Parameter. If not set, "String" is the default.
    
    Parameters:
    
    type - the type of the Parameter
  - reset
```
public void reset()
```
    Clear value

Class Parameter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ENCODING_NONE

ENCODING_BASE64_BYTE_ARRAY

ENCODING_HEX_BYTE_ARRAY

ENCODING_DEFAULT

TYPE_BYTEARRAY

TYPE_STRING

TYPE_LONG

TYPE_INTEGER

TYPE_DEFAULT

Constructor Detail

Parameter

Parameter

Parameter

Method Detail

getId

getValue

setId

setValue

toString

equals

hashCode

clone

getEncoding

setEncoding

getType

setType

reset