Class GnuSecretKey

public GnuSecretKey(byte[] key,
                    int offset,
                    int length,
                    String algorithm)

Creates a new secret key from a portion of a byte array.

Parameters:

key - The raw, secret key.

offset - The offset at which the key begins.

length - The number of bytes that comprise the key.

algorithm - The algorithm name, which can be null or empty.

public GnuSecretKey(byte[] key,
                    String algorithm)

Creates a new secret key. The supplied byte array is copied by this constructor.

Parameters:

key - The raw, secret key.

algorithm - The algorithm name, which can be null or empty.

public boolean equals(Object o)

Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

• It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
• It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
• It must be reflexive. a.equals(a) must always be true.
• It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
• a.equals(null) must be false.
• It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

Overrides:

equals in interface Object

Parameters:

Returns:

whether this Object is semantically equal to another

See Also:

Object.hashCode()

public String getAlgorithm()

Returns the algorithm name, if any.

Specified by:

getAlgorithm in interface Key

Returns:

The algorithm name.

public byte[] getEncoded()

Returns the encoded key, which is merely the byte array this class was created with. A reference to the internal byte array is returned, so the caller can delete this key from memory by modifying the returned array.

Specified by:

getEncoded in interface Key

Returns:

The raw key.

public String getFormat()

Returns the string "RAW".

Specified by:

getFormat in interface Key

Returns:

The string "RAW".

public String toString()

Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() and such.

It is typical, but not required, to ensure that this method never completes abruptly with a RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Overrides:

toString in interface Object

Returns:

the String representing this Object, which may be null

See Also:

getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)