net.named_data.jndn

Class ForwardingFlags

java.lang.Object

net.named_data.jndn.ForwardingFlags

public class ForwardingFlags
extends Object

A ForwardingFlags object holds the flags which specify how the forwarding daemon should forward an interest for a registered prefix. We use a separate ForwardingFlags object to retain future compatibility if the daemon forwarding bits are changed, amended or deprecated.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getActive() Get the value of the "active" flag.
boolean	getAdvertise() Get the value of the "advertise" flag.
boolean	getCapture() Get the value of the "capture" flag.
boolean	getCaptureOk() Get the value of the "captureOk" flag.
boolean	getChildInherit() Get the value of the "childInherit" flag.
int	getForwardingEntryFlags() Get an integer with the bits set according to the flags as used by the ForwardingEntry message.
boolean	getLast() Get the value of the "last" flag.
boolean	getLocal() Get the value of the "local" 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.
boolean	getTap() Get the value of the "tap" flag.
void	setActive(boolean active) Set the value of the "active" flag
void	setAdvertise(boolean advertise) Set the value of the "advertise" flag
void	setCapture(boolean capture) Set the value of the "capture" flag
void	setCaptureOk(boolean captureOk) Set the value of the "captureOk" flag
void	setChildInherit(boolean childInherit) Set the value of the "childInherit" flag
void	setForwardingEntryFlags(int forwardingEntryFlags) Set the flags according to the bits in forwardingEntryFlags as used by the ForwardingEntry message.
void	setLast(boolean last) Set the value of the "last" flag
void	setLocal(boolean local) Set the value of the "local" flag
void	setNfdForwardingFlags(int nfdForwardingFlags) Set the flags according to the NFD forwarding flags as used in the ControlParameters of the command interest.
void	setTap(boolean tap) Set the value of the "tap" flag

Methods inherited from class java.lang.Object

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

Constructor Detail

ForwardingFlags

public ForwardingFlags()

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

ForwardingFlags

public ForwardingFlags(ForwardingFlags forwardingFlags)

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

Parameters:

forwardingFlags - The ForwardingFlags to copy.

Method Detail

getActive

public final boolean getActive()

Get the value of the "active" flag.

Returns:

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

getChildInherit

public final boolean getChildInherit()

Get the value of the "childInherit" flag.

Returns:

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

getAdvertise

public final boolean getAdvertise()

Get the value of the "advertise" flag.

Returns:

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

getLast

public final boolean getLast()

Get the value of the "last" 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.

getLocal

public final boolean getLocal()

Get the value of the "local" flag.

Returns:

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

getTap

public final boolean getTap()

Get the value of the "tap" flag.

Returns:

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

getCaptureOk

public final boolean getCaptureOk()

Get the value of the "captureOk" flag.

Returns:

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

setActive

public final void setActive(boolean active)

Set the value of the "active" flag

Parameters:

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

setChildInherit

public final void setChildInherit(boolean childInherit)

Set the value of the "childInherit" flag

Parameters:

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

setAdvertise

public final void setAdvertise(boolean advertise)

Set the value of the "advertise" flag

Parameters:

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

setLast

public final void setLast(boolean last)

Set the value of the "last" flag

Parameters:

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

setCapture

public final void setCapture(boolean capture)

Set the value of the "capture" flag

Parameters:

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

setLocal

public final void setLocal(boolean local)

Set the value of the "local" flag

Parameters:

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

setTap

public final void setTap(boolean tap)

Set the value of the "tap" flag

Parameters:

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

setCaptureOk

public final void setCaptureOk(boolean captureOk)

Set the value of the "captureOk" flag

Parameters:

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

getForwardingEntryFlags

public final int getForwardingEntryFlags()

Get an integer with the bits set according to the flags as used by the ForwardingEntry message.

Returns:

An integer with the bits set.

setForwardingEntryFlags

public final void setForwardingEntryFlags(int forwardingEntryFlags)

Set the flags according to the bits in forwardingEntryFlags as used by the ForwardingEntry message.

Parameters:

forwardingEntryFlags - An integer with the bits set.

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.

Returns:

An integer with the bits set.

setNfdForwardingFlags

public final void 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.