net.java.truecommons.key.spec

Class AbstractKey<K extends AbstractKey<K>>

java.lang.Object

net.java.truecommons.key.spec.AbstractKey<K>

Type Parameters:

K - the type of this safe key.

All Implemented Interfaces:

Serializable, Cloneable, Key<K>

Direct Known Subclasses:

AbstractSecretKey

@Immutable
public abstract class AbstractKey<K extends AbstractKey<K>>
extends Object
implements Key<K>, Serializable

A JavaBean with basic properties for life cycle management.

Subclasses need to be serializable with Object(Out|In)putStream and XML(En|De)coder. Subclasses do not need to be safe for multi-threading.

Since:

TrueCommons 2.2

Author:

Christian Schlichtherle

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractKey()

Method Summary

Modifier and Type	Method and Description
K	clone() Returns a deep clone of this safe key.
boolean	equals(Object obj) Returns true if and only if this safe key deeply equals the given object.
abstract int	hashCode() Returns a hash code which is consistent with Key.equals(Object).

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.java.truecommons.key.spec.Key

reset

Constructor Detail

AbstractKey

public AbstractKey()

Method Detail

clone

public K clone()

Description copied from interface: Key

Returns a deep clone of this safe key. The returned object does not share any mutable state with this object.

Specified by:

clone in interface Key<K extends AbstractKey<K>>

Overrides:

clone in class Object

equals

public boolean equals(@Nullable
                      Object obj)

Description copied from interface: Key

Returns true if and only if this safe key deeply equals the given object. A safe key equals another object if and only if the other object has the same runtime class and all its properties compare deeply equal.

Specified by:

equals in interface Key<K extends AbstractKey<K>>

Overrides:

equals in class Object

hashCode

public abstract int hashCode()

Description copied from interface: Key

Returns a hash code which is consistent with Key.equals(Object). This method is provided for completeness only - you should actually never use secret keys as hash map keys because of their mutable properties!

Specified by:

hashCode in interface Key<K extends AbstractKey<K>>

Overrides:

hashCode in class Object