net.named_data.jndn

Class DelegationSet

java.lang.Object

net.named_data.jndn.DelegationSet

public class DelegationSet
extends Object

A DelegationSet holds a list of DelegationSet.Delegation entries which is used as the content of a Link instance. If you add elements with add(), then the list is a set sorted by preference number then by name. But wireDecode will add the elements from the wire encoding, preserving the given order and possible duplicates (in which case a DelegationSet really holds a "list" and not necessarily a "set").

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DelegationSet.Delegation A DelegationSet.Delegation holds a preference number and delegation name.

Constructor Summary

Constructors

Constructor and Description
DelegationSet() Create a DelegationSet with an empty list of delegations.
DelegationSet(DelegationSet delegationSet) Create a DelegationSet, copying values from the other DelegationSet.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(int preference, Name name) Add a new DelegationSet.Delegation to the list of delegations, sorted by preference number then by name.
void	addUnsorted(int preference, Name name) Add a new DelegationSet.Delegation to the end of the list of delegations, without sorting or updating any existing entries.
void	clear() Clear the list of delegations.
int	find(Name name) Find the first delegation with the given name and return its index.
DelegationSet.Delegation	get(int i) Get the delegation at the given index, according to the ordering described in add().
boolean	remove(Name name) Remove every DelegationSet.Delegation with the given name.
int	size() Get the number of delegation entries.
void	wireDecode(Blob input) Decode the input using the default wire format WireFormat.getDefaultWireFormat() and update this DelegationSet.
void	wireDecode(Blob input, WireFormat wireFormat) Decode the input using a particular wire format and update this DelegationSet.
void	wireDecode(ByteBuffer input) Decode the input using the default wire format WireFormat.getDefaultWireFormat() and update this DelegationSet, using addUnsorted() to preserve the given order and possible duplicates.
void	wireDecode(ByteBuffer input, WireFormat wireFormat) Decode the input using a particular wire format and update this DelegationSet, using addUnsorted() to preserve the given order and possible duplicates.
Blob	wireEncode() Encode this DelegationSet for the default wire format WireFormat.getDefaultWireFormat().
Blob	wireEncode(WireFormat wireFormat) Encode this DelegationSet for a particular wire format.

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegationSet

public DelegationSet()

Create a DelegationSet with an empty list of delegations.

DelegationSet

public DelegationSet(DelegationSet delegationSet)

Create a DelegationSet, copying values from the other DelegationSet.

Parameters:

delegationSet - The DelegationSet to copy values from.

Method Detail

add

public final void add(int preference,
       Name name)

Add a new DelegationSet.Delegation to the list of delegations, sorted by preference number then by name. If there is already a delegation with the same name, update its preference, and remove any extra delegations with the same name.

Parameters:

preference - The preference number.

name - The delegation name. This makes a copy of the name.

addUnsorted

public final void addUnsorted(int preference,
               Name name)

Add a new DelegationSet.Delegation to the end of the list of delegations, without sorting or updating any existing entries. This is useful for adding preferences from a wire encoding, preserving the supplied ordering and possible duplicates.

Parameters:

preference - The preference number.

name - The delegation name. This makes a copy of the name.

remove

public final boolean remove(Name name)

Remove every DelegationSet.Delegation with the given name.

Parameters:

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

Returns:

True if a DelegationSet.Delegation was removed, otherwise false.

clear

public final void clear()

Clear the list of delegations.

size

public final int size()

Get the number of delegation entries.

Returns:

The number of delegation entries.

get

public final DelegationSet.Delegation get(int i)

Get the delegation at the given index, according to the ordering described in add().

Parameters:

i - The index of the component, starting from 0.

Returns:

The delegation at the index.

find

public final int find(Name name)

Find the first delegation with the given name and return its index.

Parameters:

name - Then name of the delegation to find.

Returns:

The index of the delegation, or -1 if not found.

wireEncode

public final Blob wireEncode(WireFormat wireFormat)

Encode this DelegationSet for a particular wire format.

Parameters:

wireFormat - A WireFormat object used to encode this DelegationSet.

Returns:

The encoded buffer.

wireEncode

public final Blob wireEncode()

Encode this DelegationSet for the default wire format WireFormat.getDefaultWireFormat().

Returns:

The encoded buffer.

wireDecode

public final void wireDecode(ByteBuffer input,
              WireFormat wireFormat)
                      throws EncodingException

Decode the input using a particular wire format and update this DelegationSet, using addUnsorted() to preserve the given order and possible duplicates.

Parameters:

input - The input buffer to decode. This reads from position() to limit(), but does not change the position.

wireFormat - A WireFormat object used to decode the input.

Throws:

EncodingException - For invalid encoding.

wireDecode

public final void wireDecode(ByteBuffer input)
                      throws EncodingException

Decode the input using the default wire format WireFormat.getDefaultWireFormat() and update this DelegationSet, using addUnsorted() to preserve the given order and possible duplicates.

Parameters:

input - The input buffer to decode. This reads from position() to limit(), but does not change the position.

Throws:

EncodingException - For invalid encoding.

wireDecode

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

Decode the input using a particular wire format and update this DelegationSet.

Parameters:

input - The input blob to decode.

wireFormat - A WireFormat object used to decode the input.

Throws:

EncodingException - For invalid encoding.

wireDecode

public final void wireDecode(Blob input)
                      throws EncodingException

Decode the input using the default wire format WireFormat.getDefaultWireFormat() and update this DelegationSet.

Parameters:

input - The input blob to decode.

Throws:

EncodingException - For invalid encoding.