CipherTransformation (JavaDocs for mmm-crypto-jce 1.0.0-beta4)

java.lang.Object
- net.sf.mmm.crypto.crypt.CipherTransformation

All Implemented Interfaces:

CryptoAlgorithm
```
public class CipherTransformation
extends Object
implements CryptoAlgorithm
```
Simple representation of a Cipher transformation. Please be careful not to confuse or mix algorithm and transformation.

Since:

1.0.0

Field Summary

Fields
Modifier and Type	Field and Description
`private String`	`algorithm`
`private String`	`mode`
`static String`	`MODE_GCM` `Mode` value "GCM" (Galois/Counter Mode).
`private String`	`padding`
`static String`	`PADDING_NONE` `Padding` value "NoPadding".
`private static String`	`SEPARATOR`
`private String`	`transformation`

Constructor Summary

Constructors
Constructor and Description
`CipherTransformation(String algorithm)` The constructor.
`CipherTransformation(String algorithm, String mode, String padding)` The constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getAlgorithm()`
`String`	`getMode()`
`String`	`getPadding()`
`String`	`getTransformation()`
`int`	`hashCode()`
`static CipherTransformation`	`of(String transformation)`
`String`	`toString()`

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

- Field Detail
  - PADDING_NONE
```
public static final String PADDING_NONE
```
    Padding value "NoPadding".
    
    See Also:
    
    Constant Field Values
  - MODE_GCM
```
public static final String MODE_GCM
```
    Mode value "GCM" (Galois/Counter Mode).
    
    See Also:
    
    Constant Field Values
  - SEPARATOR
```
private static final String SEPARATOR
```
    See Also:
    
    Constant Field Values
  - algorithm
```
private final String algorithm
```
  - mode
```
private final String mode
```
  - padding
```
private final String padding
```
  - transformation
```
private final String transformation
```
- Constructor Detail
  - CipherTransformation
```
public CipherTransformation(String algorithm)
```
    The constructor. Be careful not to confuse with of(String) to create from transformation.
    
    Parameters:
    
    algorithm - - see getAlgorithm().
  - CipherTransformation
```
public CipherTransformation(String algorithm,
                            String mode,
                            String padding)
```
    The constructor.
    
    Parameters:
    
    algorithm - - see getAlgorithm().
    
    mode - - see getMode().
    
    padding - - see getPadding().
- Method Detail
  - getAlgorithm
```
public String getAlgorithm()
```
    Specified by:
    
    getAlgorithm in interface CryptoAlgorithm
    
    Returns:
    
    the encryption algorithm. See Cipher Algorithm Names.
    
    See Also:
    
    Key.getAlgorithm(), Signature.getAlgorithm(), MessageDigest.getAlgorithm(), SecureRandom.getAlgorithm(), Cipher.getAlgorithm()
  - getMode
```
public String getMode()
```
    Returns:
    
    the cipher mode mode.
  - getPadding
```
public String getPadding()
```
    Returns:
    
    the cipher padding padding.
  - getTransformation
```
public String getTransformation()
```
    Returns:
    
    the cipher transformation composed of algorithm, mode, and padding.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - of
```
public static CipherTransformation of(String transformation)
```
    Parameters:
    
    transformation - the transformation.
    
    Returns:
    
    the parsed CipherTransformation.

Class CipherTransformation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PADDING_NONE

MODE_GCM

SEPARATOR

algorithm

mode

padding

transformation

Constructor Detail

CipherTransformation

CipherTransformation

Method Detail

getAlgorithm

getMode

getPadding

getTransformation

hashCode

equals

toString

of