net.named_data.jndn

Class RegistrationOptions

java.lang.Object

net.named_data.jndn.RegistrationOptions

Direct Known Subclasses:

ForwardingFlags

public class RegistrationOptions
extends Object

A RegistrationOptions holds the options used when registering with the forwarder to specify how to forward an interest and other options. We use a separate RegistrationOptions object to retain future compatibility if the format of the registration command is changed. (This class was renamed from ForwardingFlags, which is deprecated.)

Constructor Summary

Constructors

Constructor and Description
RegistrationOptions() Create a new RegistrationOptions with "childInherit" set and all other flags cleared.
RegistrationOptions(RegistrationOptions registrationOptions) Create a new RegistrationOptions as a copy of the given value.

Method Summary

Modifier and Type	Method and Description
boolean	getCapture() Get the value of the "capture" flag.
boolean	getChildInherit() Get the value of the "childInherit" flag.
int	getNfdForwardingFlags() Get an integer with the bits set according to the NFD forwarding flags as used in the ControlParameters of the command interest.
int	getOrigin() Get the origin value.
RegistrationOptions	setCapture(boolean capture) Set the value of the "capture" flag
RegistrationOptions	setChildInherit(boolean childInherit) Set the value of the "childInherit" flag
RegistrationOptions	setNfdForwardingFlags(int nfdForwardingFlags) Set the flags according to the NFD forwarding flags as used in the ControlParameters of the command interest.
RegistrationOptions	setOrigin(int origin) Set the origin value.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegistrationOptions

public RegistrationOptions()

Create a new RegistrationOptions with "childInherit" set and all other flags cleared.

RegistrationOptions

public RegistrationOptions(RegistrationOptions registrationOptions)

Create a new RegistrationOptions as a copy of the given value.

Parameters:

registrationOptions - The RegistrationOptions to copy.

Method Detail

getChildInherit

public final boolean getChildInherit()

Get the value of the "childInherit" flag.

Returns:

true if the flag is set, false if it is cleared.

getCapture

public final boolean getCapture()

Get the value of the "capture" flag.

Returns:

true if the flag is set, false if it is cleared.

getOrigin

public final int getOrigin()

Get the origin value.

Returns:

The origin value, or -1 if not specified.

setChildInherit

public final RegistrationOptions setChildInherit(boolean childInherit)

Set the value of the "childInherit" flag

Parameters:

childInherit - true to set the flag, false to clear it.

Returns:

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

setCapture

public final RegistrationOptions setCapture(boolean capture)

Set the value of the "capture" flag

Parameters:

capture - true to set the flag, false to clear it.

Returns:

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

setOrigin

public final RegistrationOptions setOrigin(int origin)

Set the origin value.

Parameters:

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

Returns:

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

getNfdForwardingFlags

public final int getNfdForwardingFlags()

Get an integer with the bits set according to the NFD forwarding flags as used in the ControlParameters of the command interest. This ignores the origin value.

Returns:

An integer with the bits set.

setNfdForwardingFlags

public final RegistrationOptions setNfdForwardingFlags(int nfdForwardingFlags)

Set the flags according to the NFD forwarding flags as used in the ControlParameters of the command interest.

Parameters:

nfdForwardingFlags - An integer with the bits set.

Returns:

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