XdhKeySpec

Kotlin |Java

public final class XdhKeySpec
extends EncodedKeySpec

java.lang.Object
↳	java.security.spec.EncodedKeySpec
	↳	android.crypto.hpke.XdhKeySpec

External Diffie\u2013Hellman (XDH) key spec holding either a public or private key.

Subclasses EncodedKeySpec using the non-Standard "raw" format. The XdhKeyFactory class utilises this in order to create XDH keys from raw bytes and to return them as an XdhKeySpec allowing the raw key material to be extracted from an XDH key.

Summary

Public constructors
`XdhKeySpec(byte[] encoded)` Creates an instance of `XdhKeySpec` by passing a public or private key in its raw format.

Public methods
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`String`	`getFormat()` Returns the name of the encoding format associated with this key specification.
`byte[]`	`getKey()` Returns the public or private key in its raw format.
`int`	`hashCode()` Returns a hash code value for the object.

Inherited methods

From class


        
          java.security.spec.EncodedKeySpec

`String`	`getAlgorithm()` Returns the name of the algorithm of the encoded key.
`byte[]`	`getEncoded()` Returns the encoded key.
`abstract String`	`getFormat()` Returns the name of the encoding format associated with this key specification.

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

XdhKeySpec

Added in API level 35

public XdhKeySpec (byte[] encoded)

Creates an instance of XdhKeySpec by passing a public or private key in its raw format.

Parameters
`encoded`	`byte`: This value cannot be `null`.

Public methods

equals

Added in API level 35

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
`o`	`Object`: the reference object with which to compare.

Returns
`boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getFormat

Added in API level 35

public String getFormat ()

Returns the name of the encoding format associated with this key specification.

If the opaque representation of a key (see Key) can be transformed (see KeyFactory) into this key specification (or a subclass of it), getFormat called on the opaque key returns the same value as the getFormat method of this key specification.

Returns
`String`	This value cannot be `null`.

getKey

Added in API level 35

public byte[] getKey ()

Returns the public or private key in its raw format.

Returns
`byte[]`	key in its raw format. This value cannot be `null`.

hashCode

Added in API level 35

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
`int`	a hash code value for this object.