PairingParameters (JPBC - API 2.0.0 API)

All Superinterfaces:

Serializable
```
public interface PairingParameters
extends Serializable
```
Represents the set of parameters describing a pairing.

Since:

2.0.0

Author:

Angelo De Caro (jpbclib@gmail.com)

See Also:
PairingParametersGenerator, PairingParametersGenerator.generate()

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`containsKey(String key)` Returns `true` if a mapping for the specified key exists.
`BigInteger`	`getBigInteger(String key)` Returns the value as a BigInteger to which the specified key is mapped.
`BigInteger`	`getBigInteger(String key, BigInteger defaultValue)` Returns the BigInteger to which the specified key is mapped.
`BigInteger`	`getBigIntegerAt(String key, int index)` Returns the BigInteger at the specified index in the array to which the specified key is mapped.
`byte[]`	`getBytes(String key)` Returns the value as an array of bytes to which the specified key is mapped.
`byte[]`	`getBytes(String key, byte[] defaultValue)` Returns the value as an array of bytes to which the specified key is mapped.
`int`	`getInt(String key)` Returns the value as an int to which the specified key is mapped.
`int`	`getInt(String key, int defaultValue)` Returns the value as an int to which the specified key is mapped.
`long`	`getLong(String key)` Returns the value as a long to which the specified key is mapped.
`long`	`getLong(String key, long defaultValue)` Returns the value as a long to which the specified key is mapped.
`Object`	`getObject(String key)` Returns the object to which the specified key is mapped.
`String`	`getString(String key)` Returns the value as a string to which the specified key is mapped.
`String`	`getString(String key, String defaultValue)` Returns the value as a string to which the specified key is mapped.
`String`	`toString(String separator)` Returns a string representation of the parameters using the specified key/value separator.

- Method Detail
  - containsKey
```
boolean containsKey(String key)
```
    Returns true if a mapping for the specified key exists.
    
    Parameters:
    key - key whose presence is to be tested
    
    Returns:
    true if a mapping for the specified key exists.
    Since:
    
    2.0.0
  - getString
```
String getString(String key)
```
    Returns the value as a string to which the specified key is mapped.
    
    Parameters:
    key - the key whose associated value is to be returned
    
    Returns:
    the value as a string to which the specified key is mapped.
    
    Throws:
    
    IllegalArgumentException - if the specified key does not exists.
    Since:
    
    2.0.0
  - getString
```
String getString(String key,
               String defaultValue)
```
    Returns the value as a string to which the specified key is mapped. If the mapping does not exist the passed defaultValue is returned.
    
    Parameters:
    key - the key whose associated value is to be returned
    
    Returns:
    the value as a string to which the specified key is mapped. If the mapping does not exist the passed defaultValue is returned.
    Since:
    
    2.0.0
  - getInt
```
int getInt(String key)
```
    Returns the value as an int to which the specified key is mapped.
    
    Parameters:
    key - the key whose associated value is to be returned
    
    Returns:
    the value as an int to which the specified key is mapped.
    
    Throws:
    
    IllegalArgumentException - if the specified key does not exists.
    Since:
    
    2.0.0
  - getInt
```
int getInt(String key,
         int defaultValue)
```
    Returns the value as an int to which the specified key is mapped. If the mapping does not exist the passed defaultValue is returned.
    
    Parameters:
    key - the key whose associated value is to be returned
    
    Returns:
    the value as an int to which the specified key is mapped. If the mapping does not exist the passed defaultValue is returned.
    Since:
    
    2.0.0
  - getBigInteger
```
BigInteger getBigInteger(String key)
```
    Returns the value as a BigInteger to which the specified key is mapped.
    
    Parameters:
    key - the key whose associated value is to be returned
    
    Returns:
    the value as a BigInteger to which the specified key is mapped.
    
    Throws:
    
    IllegalArgumentException - if the specified key does not exists.
    Since:
    
    2.0.0
  - getBigInteger
```
BigInteger getBigInteger(String key,
                       BigInteger defaultValue)
```
    Returns the BigInteger to which the specified key is mapped. If the mapping does not exist the passed defaultValue is returned.
    
    Parameters:
    key - the key whose associated value is to be returned
    
    Returns:
    the BigInteger to which the specified key is mapped. If the mapping does not exist the passed defaultValue is returned.
    Since:
    
    2.0.0
  - getBigIntegerAt
```
BigInteger getBigIntegerAt(String key,
                         int index)
```
    Returns the BigInteger at the specified index in the array to which the specified key is mapped.
    
    Parameters:
    key - the key whose associated array is to be used
    index - the index relative to the array.
    
    Returns:
    the BigInteger at the specified index in the array to which the specified key is mapped.
    Since:
    
    2.0.0
  - getLong
```
long getLong(String key)
```
    Returns the value as a long to which the specified key is mapped.
    
    Parameters:
    key - the key whose associated value is to be returned
    
    Returns:
    the value as a long to which the specified key is mapped.
    
    Throws:
    
    IllegalArgumentException - if the specified key does not exists.
    Since:
    
    2.0.0
  - getLong
```
long getLong(String key,
           long defaultValue)
```
    Returns the value as a long to which the specified key is mapped. If the mapping does not exist the passed defaultValue is returned.
    
    Parameters:
    key - the key whose associated value is to be returned
    
    Returns:
    the value as a long to which the specified key is mapped. If the mapping does not exist the passed defaultValue is returned.
    Since:
    
    2.0.0
  - getBytes
```
byte[] getBytes(String key)
```
    Returns the value as an array of bytes to which the specified key is mapped.
    
    Parameters:
    key - the key whose associated value is to be returned
    
    Returns:
    the value as an array of bytes to which the specified key is mapped.
    
    Throws:
    
    IllegalArgumentException - if the specified key does not exists.
    Since:
    
    2.0.0
  - getBytes
```
byte[] getBytes(String key,
              byte[] defaultValue)
```
    Returns the value as an array of bytes to which the specified key is mapped.
    
    Parameters:
    key - the key whose associated value is to be returned
    
    Returns:
    the value as an array of bytes to which the specified key is mapped.
    
    Throws:
    
    IllegalArgumentException - if the specified key does not exists.
    Since:
    
    2.0.0
  - toString
```
String toString(String separator)
```
    Returns a string representation of the parameters using the specified key/value separator.
    
    Parameters:
    separator - key/value separator separator to be used .
    
    Returns:
    a string representation of the parameters.
    Since:
    
    2.0.0
  - getObject
```
Object getObject(String key)
```
    Returns the object to which the specified key is mapped.
    
    Parameters:
    key - the key whose associated object is to be returned
    Since:
    
    2.0.0

Interface PairingParameters

Method Summary

Method Detail

containsKey

getString

getString

getInt

getInt

getBigInteger

getBigInteger

getBigIntegerAt

getLong

getLong

getBytes

getBytes

toString

getObject