net.named_data.jndn

Class KeyLocator

java.lang.Object

net.named_data.jndn.KeyLocator

All Implemented Interfaces:

ChangeCountable

public class KeyLocator
extends Object
implements ChangeCountable

Constructor Summary

Constructors

Constructor and Description
KeyLocator() Create a new KeyLocator with default values.
KeyLocator(KeyLocator keyLocator) Create a new KeyLocator with a copy of the fields in keyLocator.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	canGetFromSignature(Signature signature) If the signature is a type that has a KeyLocator (so that getFromSignature will succeed), return true.
void	clear() Clear fields and reset to default values.
boolean	equals(KeyLocator other) Check if this key locator has the same values as the given key locator.
boolean	equals(Object other)
long	getChangeCount() Get the change count, which is incremented each time this object (or a child object) is changed.
static KeyLocator	getFromSignature(Signature signature) If the signature is a type that has a KeyLocator, then return it.
Blob	getKeyData()
Name	getKeyName()
KeyLocatorType	getType()
void	setKeyData(Blob keyData)
void	setKeyName(Name keyName)
void	setType(KeyLocatorType type)

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyLocator

public KeyLocator()

Create a new KeyLocator with default values.

KeyLocator

public KeyLocator(KeyLocator keyLocator)

Create a new KeyLocator with a copy of the fields in keyLocator.

Parameters:

keyLocator - The KeyLocator to copy.

Method Detail

getType

public final KeyLocatorType getType()

getKeyData

public final Blob getKeyData()

getKeyName

public final Name getKeyName()

setType

public final void setType(KeyLocatorType type)

setKeyData

public final void setKeyData(Blob keyData)

setKeyName

public final void setKeyName(Name keyName)

clear

public final void clear()

Clear fields and reset to default values.

equals

public boolean equals(KeyLocator other)

Check if this key locator has the same values as the given key locator.

Parameters:

other - The other key locator to check.

Returns:

true if the key locators are equal, otherwise false.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

canGetFromSignature

public static boolean canGetFromSignature(Signature signature)

If the signature is a type that has a KeyLocator (so that getFromSignature will succeed), return true. Note: This is a static method of KeyLocator instead of a method of Signature so that the Signature base class does not need to be overloaded with all the different kinds of information that various signature algorithms may use.

Parameters:

signature - An object of a subclass of Signature.

Returns:

True if the signature is a type that has a KeyLocator, otherwise false.

getFromSignature

public static KeyLocator getFromSignature(Signature signature)

If the signature is a type that has a KeyLocator, then return it. Otherwise throw an error.

Parameters:

signature - An object of a subclass of Signature.

Returns:

The signature's KeyLocator. It is an error if signature doesn't have a KeyLocator.

getChangeCount

public final long getChangeCount()

Get the change count, which is incremented each time this object (or a child object) is changed.

Specified by:

getChangeCount in interface ChangeCountable

Returns:

The change count.