net.named_data.jndn

Class ControlParameters

java.lang.Object

net.named_data.jndn.ControlParameters

public class ControlParameters
extends Object

A ControlParameters holds a Name and other fields for a ControlParameters which is used, for example, in the command interest to register a prefix with a forwarder. Note: getters will never be null so check for empty Names with something like `controlParameters.getStrategy().size() != 0`

Constructor Summary

Constructors

Constructor and Description
ControlParameters() Create a new ControlParameters where all values are unspecified.
ControlParameters(ControlParameters controlParameters) Create a new ControlParameters as a deep copy of the given controlParameters.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear fields and reset to default values.
boolean	equals(Object other)
int	getCost()
double	getExpirationPeriod()
int	getFaceId()
RegistrationOptions	getForwardingFlags()
int	getLocalControlFeature()
Name	getName() Get the name.
int	getOrigin()
Name	getStrategy()
String	getUri()
ControlParameters	setCost(int cost) Set the cost value.
ControlParameters	setExpirationPeriod(double expirationPeriod) Set the expiration period.
ControlParameters	setFaceId(int faceId) Set the Face ID.
ControlParameters	setForwardingFlags(RegistrationOptions flags) Set the RegistrationOptions object to a copy of flags.
ControlParameters	setLocalControlFeature(int localControlFeature) Set the local control feature value.
ControlParameters	setName(Name name) Set the name.
ControlParameters	setOrigin(int origin) Set the origin value.
ControlParameters	setStrategy(Name strategy) Set the strategy to a copy of the given Name.
ControlParameters	setUri(String uri) Set the URI.
void	wireDecode(Blob input) Decode the input using the default wire format WireFormat.getDefaultWireFormat() and update this ControlParameters.
void	wireDecode(Blob input, WireFormat wireFormat) Decode the input using a particular wire format and update this ControlParameters.
void	wireDecode(ByteBuffer input) Decode the input using the default wire format WireFormat.getDefaultWireFormat() and update this ControlParameters.
void	wireDecode(ByteBuffer input, WireFormat wireFormat) Decode the input using a particular wire format and update this ControlParameters.
Blob	wireEncode() Encode this ControlParameters for the default wire format WireFormat.getDefaultWireFormat().
Blob	wireEncode(WireFormat wireFormat) Encode this ControlParameters for a particular wire format.

Methods inherited from class java.lang.Object

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

Constructor Detail

ControlParameters

public ControlParameters()

Create a new ControlParameters where all values are unspecified.

ControlParameters

public ControlParameters(ControlParameters controlParameters)

Create a new ControlParameters as a deep copy of the given controlParameters.

Parameters:

controlParameters - The ControlParameters to copy.

Method Detail

wireEncode

public final Blob wireEncode(WireFormat wireFormat)

Encode this ControlParameters for a particular wire format.

Parameters:

wireFormat - A WireFormat object used to encode this ControlParameters.

Returns:

The encoded buffer.

wireEncode

public final Blob wireEncode()

Encode this ControlParameters 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 ControlParameters.

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 ControlParameters.

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 ControlParameters.

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 ControlParameters.

Parameters:

input - The input blob to decode.

Throws:

EncodingException - For invalid encoding.

getName

public final Name getName()

Get the name.

Returns:

The Name. If not specified, return null.

getFaceId

public final int getFaceId()

getUri

public final String getUri()

getLocalControlFeature

public final int getLocalControlFeature()

getOrigin

public final int getOrigin()

getCost

public final int getCost()

getForwardingFlags

public final RegistrationOptions getForwardingFlags()

getStrategy

public final Name getStrategy()

getExpirationPeriod

public final double getExpirationPeriod()

setName

public final ControlParameters setName(Name name)

Set the name.

Parameters:

name - The name. If not specified, set to null. If specified, this makes a copy of the name.

Returns:

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

setFaceId

public final ControlParameters setFaceId(int faceId)

Set the Face ID.

Parameters:

faceId - The new face ID, or -1 for not specified.

Returns:

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

setUri

public final ControlParameters setUri(String uri)

Set the URI.

Parameters:

uri - The new uri, or an empty string for not specified.

Returns:

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

setLocalControlFeature

public final ControlParameters setLocalControlFeature(int localControlFeature)

Set the local control feature value.

Parameters:

localControlFeature - The new local control feature value, or -1 for not specified.

Returns:

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

setOrigin

public final ControlParameters setOrigin(int origin)

Set the origin value.

Parameters:

origin - The new origin value, or -1 for not specified.

Returns:

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

setCost

public final ControlParameters setCost(int cost)

Set the cost value.

Parameters:

cost - The new cost value, or -1 for not specified.

Returns:

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

setForwardingFlags

public final ControlParameters setForwardingFlags(RegistrationOptions flags)

Set the RegistrationOptions object to a copy of flags. You can use getForwardingFlags() and change the existing RegistrationOptions object.

Parameters:

flags - The new RegistrationOptions object containing the flags, or null for not specified.

Returns:

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

setStrategy

public final ControlParameters setStrategy(Name strategy)

Set the strategy to a copy of the given Name.

Parameters:

strategy - The Name to copy, or an empty Name if not specified.

Returns:

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

setExpirationPeriod

public final ControlParameters setExpirationPeriod(double expirationPeriod)

Set the expiration period.

Parameters:

expirationPeriod - The expiration period in milliseconds, or null for not specified.

Returns:

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

clear

public final void clear()

Clear fields and reset to default values.

equals

public boolean equals(Object other)

Overrides:

equals in class Object