net.named_data.jndn

Class Link

java.lang.Object

net.named_data.jndn.Data

net.named_data.jndn.Link

All Implemented Interfaces:

SignatureHolder, ChangeCountable

public class Link
extends Data

The Link class extends Data and represents a Link instance where the Data content is an encoded delegation set. The format is defined in "link.pdf" attached to Redmine issue http://redmine.named-data.net/issues/2587 .

Constructor Summary

Constructors

Constructor and Description
Link() Create a Link with default values and where the list of delegations is empty and the meta info type is LINK.
Link(Data data) Create a Link, copying values from the other Data object.
Link(Name name) Create a Link with the given name and default values and where the list of delegations is empty and the meta info type is LINK.

Method Summary

Modifier and Type	Method and Description
Link	addDelegation(int preference, Name name) Add a new delegation to the list of delegations, sorted by preference number then by name.
Link	addDelegation(int preference, Name name, WireFormat wireFormat) Add a new delegation to the list of delegations, sorted by preference number then by name.
DelegationSet	getDelegations() Get the list of delegation for read only.
boolean	removeDelegation(Name name) Remove every delegation with the given name.
boolean	removeDelegation(Name name, WireFormat wireFormat) Remove every delegation with the given name.
void	wireDecode(Blob input, WireFormat wireFormat) Override to call the base class wireDecode then populate the list of delegations from the content.

Methods inherited from class net.named_data.jndn.Data

getChangeCount, getContent, getDefaultWireEncoding, getFullName, getFullName, getIncomingFaceId, getMetaInfo, getName, getSignature, setContent, setMetaInfo, setName, setSignature, wireDecode, wireDecode, wireDecode, wireEncode, wireEncode

Methods inherited from class java.lang.Object

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

Constructor Detail

Link

public Link()

Create a Link with default values and where the list of delegations is empty and the meta info type is LINK.

Link

public Link(Name name)

Create a Link with the given name and default values and where the list of delegations is empty and the meta info type is LINK.

Parameters:

name - The name which is copied.

Link

public Link(Data data)

Create a Link, copying values from the other Data object. If the content can be decoded using the default wire encoding, then update the list of delegations.

Parameters:

data - The Data object to copy values from.

Method Detail

wireDecode

public void wireDecode(Blob input,
                       WireFormat wireFormat)
                throws EncodingException

Override to call the base class wireDecode then populate the list of delegations from the content.

Overrides:

wireDecode in class Data

Parameters:

input - The input byte array to be decoded as an immutable Blob.

wireFormat - A WireFormat object used to decode the input.

Throws:

EncodingException - For invalid encoding.

addDelegation

public final Link addDelegation(int preference,
                                Name name,
                                WireFormat wireFormat)

Add a new delegation to the list of delegations, sorted by preference number then by name. Re-encode this object's content using the given wireFormat.

Parameters:

preference - The preference number.

name - The delegation name. This makes a copy of the name. If there is already a delegation with the same name, this updates its preference.

wireFormat - A WireFormat object used to encode the DelegationSet.

Returns:

This Link so that you can chain calls to update values.

addDelegation

public final Link addDelegation(int preference,
                                Name name)

Add a new delegation to the list of delegations, sorted by preference number then by name. Re-encode this object's content using the default wire format.

Parameters:

preference - The preference number.

name - The delegation name. This makes a copy of the name. If there is already a delegation with the same name, this updates its preference.

Returns:

This Link so that you can chain calls to update values.

removeDelegation

public final boolean removeDelegation(Name name,
                                      WireFormat wireFormat)

Remove every delegation with the given name. Re-encode this object's content using the given wireFormat.

Parameters:

name - Then name to match the name of the delegation(s) to be removed.

wireFormat - A WireFormat object used to encode the DelegationSet.

Returns:

True if a delegation was removed, otherwise false.

removeDelegation

public final boolean removeDelegation(Name name)

Remove every delegation with the given name. Re-encode this object's content using the default wire format.

Parameters:

name - Then name to match the name of the delegation(s) to be removed.

Returns:

True if a delegation was removed, otherwise false.

getDelegations

public final DelegationSet getDelegations()

Get the list of delegation for read only.

Returns:

The list of delegation, which you should treat as read-only. To modify it, call Link.addDelegation, etc.