Interest (jndn 0.22 API)

java.lang.Object
- net.named_data.jndn.Interest

All Implemented Interfaces:

ChangeCountable
```
public class Interest
extends Object
implements ChangeCountable
```
An Interest holds a Name and other fields for an interest.

Field Summary

Fields
Modifier and Type Field and Description

static int CHILD_SELECTOR_LEFT

static int CHILD_SELECTOR_RIGHT

Fields
Modifier and Type	Field and Description
`static int`	`CHILD_SELECTOR_LEFT`
`static int`	`CHILD_SELECTOR_RIGHT`

Constructor Summary

Constructors
Constructor and Description
`Interest()` Create a new Interest with an empty name and "none" for all values.
`Interest(Interest interest)` Create a new interest as a deep copy of the given interest.
`Interest(Name name)` Create a new Interest with the given name and "none" for other values.
`Interest(Name name, double interestLifetimeMilliseconds)` Create a new Interest with the given name and interest lifetime and "none" for other values.
`Interest(String uri)` Create a new Interest with a Name from the given URI string, and "none" for other values.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Interest`	`appendParametersDigestToName()` Append the digest of the application parameters to the Name as a ParametersSha256DigestComponent.
`Blob`	`getApplicationParameters()` Get the application parameters.
`boolean`	`getCanBePrefix()` Get the CanBePrefix flag.
`long`	`getChangeCount()` Get the change count, which is incremented each time this object (or a child object) is changed.
`int`	`getChildSelector()`
`static boolean`	`getDefaultCanBePrefix()` Get the default value of the CanBePrefix flag used in the Interest constructor.
`SignedBlob`	`getDefaultWireEncoding()` Return a pointer to the defaultWireEncoding, which was encoded with getDefaultWireEncodingFormat().
`boolean`	`getDidSetCanBePrefix_()` This internal library method gets didSetCanBePrefix_ which is set true when the application calls setCanBePrefix(), or if the application had already called setDefaultCanBePrefix() before creating the Interest.
`Exclude`	`getExclude()`
`DelegationSet`	`getForwardingHint()` Get the forwarding hint object which you can modify to add or remove forwarding hints.
`long`	`getIncomingFaceId()` Get the incoming face ID according to the incoming packet header.
`double`	`getInterestLifetimeMilliseconds()`
`KeyLocator`	`getKeyLocator()`
`Link`	`getLink()` Deprecated. Use getForwardingHint.
`Blob`	`getLinkWireEncoding()` Deprecated. Use getForwardingHint.
`Blob`	`getLinkWireEncoding(WireFormat wireFormat)` Deprecated. Use getForwardingHint.
`int`	`getMaxSuffixComponents()`
`int`	`getMinSuffixComponents()`
`boolean`	`getMustBeFresh()` Get the must be fresh flag.
`Name`	`getName()`
`Blob`	`getNonce()` Return the nonce value from the incoming interest.
`Blob`	`getParameters()` Deprecated. Use getApplicationParameters.
`int`	`getSelectedDelegationIndex()` Deprecated. Use getForwardingHint.
`boolean`	`hasApplicationParameters()` Check if the application parameters are specified.
`boolean`	`hasLink()` Deprecated. Use getForwardingHint.
`boolean`	`hasParameters()` Deprecated. Use hasApplicationParameters.
`boolean`	`matchesData(Data data)` Check if the given Data packet can satisfy this Interest.
`boolean`	`matchesData(Data data, WireFormat wireFormat)` Check if the given Data packet can satisfy this Interest.
`boolean`	`matchesName(Name name)` Check if this Interest's name matches the given name (using Name.match) and the given name also conforms to the interest selectors.
`void`	`refreshNonce()` Update the bytes of the nonce with new random values.
`Interest`	`setApplicationParameters(Blob applicationParameters)` Set the application parameters to the given value.
`Interest`	`setCanBePrefix(boolean canBePrefix)` Set the CanBePrefix flag.
`Interest`	`setChildSelector(int childSelector)` Set the child selector.
`static void`	`setDefaultCanBePrefix(boolean defaultCanBePrefix)` Set the default value of the CanBePrefix flag used in the Interest constructor.
`Interest`	`setExclude(Exclude exclude)` Set this interest to use a copy of the given Exclude object.
`Interest`	`setForwardingHint(DelegationSet forwardingHint)` Set this interest to use a copy of the given DelegationSet object as the forwarding hint.
`Interest`	`setInterestLifetimeMilliseconds(double interestLifetimeMilliseconds)` Set the interest lifetime.
`Interest`	`setKeyLocator(KeyLocator keyLocator)` Set this interest to use a copy of the given KeyLocator object.
`Interest`	`setLinkWireEncoding(Blob encoding)` Deprecated. Use setForwardingHint.
`Interest`	`setLinkWireEncoding(Blob encoding, WireFormat wireFormat)` Deprecated. Use setForwardingHint.
`Interest`	`setMaxSuffixComponents(int maxSuffixComponents)` Set the max suffix components count.
`Interest`	`setMinSuffixComponents(int minSuffixComponents)` Set the min suffix components count.
`Interest`	`setMustBeFresh(boolean mustBeFresh)` Set the MustBeFresh flag.
`Interest`	`setName(Name name)` Set the interest name.
`Interest`	`setNonce(Blob nonce)` Deprecated. You should let the wire encoder generate a random nonce internally before sending the interest.
`Interest`	`setParameters(Blob applicationParameters)` Deprecated. Use setApplicationParameters.
`Interest`	`setSelectedDelegationIndex(int selectedDelegationIndex)` Deprecated. Use setForwardingHint.
`String`	`toUri()` Encode the name according to the "NDN URI Scheme".
`Interest`	`unsetLink()` Deprecated. Use setForwardingHint.
`void`	`wireDecode(Blob input)` Decode the input using the default wire format WireFormat.getDefaultWireFormat() and update this Interest.
`void`	`wireDecode(Blob input, WireFormat wireFormat)` Decode the input using a particular wire format and update this Interest.
`void`	`wireDecode(ByteBuffer input)` Decode the input using the default wire format WireFormat.getDefaultWireFormat() and update this Interest.
`void`	`wireDecode(ByteBuffer input, WireFormat wireFormat)` Decode the input using a particular wire format and update this Interest.
`SignedBlob`	`wireEncode()` Encode this Interest for the default wire format WireFormat.getDefaultWireFormat().
`SignedBlob`	`wireEncode(WireFormat wireFormat)` Encode this Interest for a particular wire format.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CHILD_SELECTOR_LEFT
```
public static final int CHILD_SELECTOR_LEFT
```
    See Also:
    
    Constant Field Values
  - CHILD_SELECTOR_RIGHT
```
public static final int CHILD_SELECTOR_RIGHT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Interest
```
public Interest(Name name,
                double interestLifetimeMilliseconds)
```
    Create a new Interest with the given name and interest lifetime and "none" for other values.
    
    Parameters:
    
    name - The name for the interest.
    
    interestLifetimeMilliseconds - The interest lifetime in milliseconds, or -1 for none.
  - Interest
```
public Interest(Name name)
```
    Create a new Interest with the given name and "none" for other values.
    
    Parameters:
    
    name - The name for the interest.
  - Interest
```
public Interest(String uri)
```
    Create a new Interest with a Name from the given URI string, and "none" for other values.
    
    Parameters:
    
    uri - The URI string.
  - Interest
```
public Interest(Interest interest)
```
    Create a new interest as a deep copy of the given interest.
    
    Parameters:
    
    interest - The interest to copy.
  - Interest
```
public Interest()
```
    Create a new Interest with an empty name and "none" for all values.
- Method Detail
  - getDefaultCanBePrefix
```
public static boolean getDefaultCanBePrefix()
```
    Get the default value of the CanBePrefix flag used in the Interest constructor. You can change this with setDefaultCanBePrefix().
    
    Returns:
    
    The default value of the CanBePrefix flag.
  - setDefaultCanBePrefix
```
public static void setDefaultCanBePrefix(boolean defaultCanBePrefix)
```
    Set the default value of the CanBePrefix flag used in the Interest constructor. The default is currently true, but will be changed at a later date. The application should call this before creating any Interest (even to set the default again to true), or the application should explicitly call setCanBePrefix() after creating the Interest. Otherwise wireEncode will print a warning message. This is to avoid breaking any code when the library default for CanBePrefix is changed at a later date.
    
    Parameters:
    
    defaultCanBePrefix - The default value of the CanBePrefix flag.
  - wireEncode
```
public final SignedBlob wireEncode(WireFormat wireFormat)
```
    Encode this Interest for a particular wire format. If wireFormat is the default wire format, also set the defaultWireEncoding field to the encoded result.
    
    Parameters:
    
    wireFormat - A WireFormat object used to encode this Interest.
    
    Returns:
    
    The encoded buffer.
  - wireEncode
```
public final SignedBlob wireEncode()
```
    Encode this Interest 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 Interest.
    
    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 Interest.
    
    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 Interest. If wireFormat is the default wire format, also set the defaultWireEncoding field another pointer to the input Blob.
    
    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 Interest.
    
    Parameters:
    
    input - The input blob to decode.
    
    Throws:
    
    EncodingException - For invalid encoding.
  - toUri
```
public final String toUri()
```
    Encode the name according to the "NDN URI Scheme". If there are interest selectors, append "?" and added the selectors as a query string. For example "/test/name?ndn.ChildSelector=1".
    
    Returns:
    
    The URI string.
    
    Note:
    
    This is an experimental feature. See the API docs for more detail at http://named-data.net/doc/ndn-ccl-api/interest.html#interest-touri-method .
  - getName
```
public final Name getName()
```
  - getMinSuffixComponents
```
public final int getMinSuffixComponents()
```
  - getMaxSuffixComponents
```
public final int getMaxSuffixComponents()
```
  - getCanBePrefix
```
public final boolean getCanBePrefix()
```
    Get the CanBePrefix flag. If not specified, the default is true, or the value from setDefaultCanBePrefix().
    
    Returns:
    
    The CanBePrefix flag.
  - getKeyLocator
```
public final KeyLocator getKeyLocator()
```
  - getExclude
```
public final Exclude getExclude()
```
  - getChildSelector
```
public final int getChildSelector()
```
  - getMustBeFresh
```
public final boolean getMustBeFresh()
```
    Get the must be fresh flag. If not specified, the default is true.
    
    Returns:
    
    The must be fresh flag.
  - getInterestLifetimeMilliseconds
```
public final double getInterestLifetimeMilliseconds()
```
  - getNonce
```
public final Blob getNonce()
```
    Return the nonce value from the incoming interest. If you change any of the fields in this Interest object, then the nonce value is cleared.
    
    Returns:
    
    The nonce.
  - getForwardingHint
```
public final DelegationSet getForwardingHint()
```
    Get the forwarding hint object which you can modify to add or remove forwarding hints.
    
    Returns:
    
    The forwarding hint as a DelegationSet.
  - hasApplicationParameters
```
public final boolean hasApplicationParameters()
```
    Check if the application parameters are specified.
    
    Returns:
    
    True if the application parameters are specified, false if not.
  - hasParameters
```
public final boolean hasParameters()
```
    Deprecated. Use hasApplicationParameters.
  - getApplicationParameters
```
public final Blob getApplicationParameters()
```
    Get the application parameters.
    
    Returns:
    
    The parameters as a Blob, which isNull() if unspecified.
  - getParameters
```
public final Blob getParameters()
```
    Deprecated. Use getApplicationParameters.
  - hasLink
```
public final boolean hasLink()
```
    Deprecated. Use getForwardingHint.
    
    Check if this interest has a link object (or a link wire encoding which can be decoded to make the link object).
    
    Returns:
    
    True if this interest has a link object, false if not.
  - getLink
```
public final Link getLink()
                   throws EncodingException
```
    Deprecated. Use getForwardingHint.
    
    Get the link object. If necessary, decode it from the link wire encoding.
    
    Returns:
    
    The link object, or null if not specified.
    
    Throws:
    
    EncodingException - For error decoding the link wire encoding (if necessary).
  - getLinkWireEncoding
```
public final Blob getLinkWireEncoding(WireFormat wireFormat)
                               throws EncodingException
```
    Deprecated. Use getForwardingHint.
    
    Get the wire encoding of the link object. If there is already a wire encoding then return it. Otherwise encode from the link object (if available).
    
    Parameters:
    
    wireFormat - The desired wire format for the encoding.
    
    Returns:
    
    The wire encoding, or an isNull Blob if the link is not specified.
    
    Throws:
    
    EncodingException - for error encoding the link object.
  - getLinkWireEncoding
```
public final Blob getLinkWireEncoding()
                               throws EncodingException
```
    Deprecated. Use getForwardingHint.
    
    Get the wire encoding of the link object. If there is already a wire encoding then return it. Otherwise encode from the link object (if available).
    
    Returns:
    
    The wire encoding, or an isNull Blob if the link is not specified.
    
    Throws:
    
    EncodingException - for error encoding the link object.
  - getSelectedDelegationIndex
```
public final int getSelectedDelegationIndex()
```
    Deprecated. Use getForwardingHint.
    
    Get the selected delegation index.
    
    Returns:
    
    The selected delegation index. If not specified, return -1.
  - getIncomingFaceId
```
public final long getIncomingFaceId()
```
    Get the incoming face ID according to the incoming packet header.
    
    Returns:
    
    The incoming face ID. If not specified, return -1.
  - setName
```
public final Interest setName(Name name)
```
    Set the interest name.
    
    Parameters:
    
    name - The interest name. This makes a copy of the name.
    
    Returns:
    
    This Interest so that you can chain calls to update values.
    
    Note:
    
    You can also call getName and change the name values directly.
  - setMinSuffixComponents
```
public final Interest setMinSuffixComponents(int minSuffixComponents)
```
    Set the min suffix components count.
    
    Parameters:
    
    minSuffixComponents - The min suffix components count. If not specified, set to -1.
    
    Returns:
    
    This Interest so that you can chain calls to update values.
  - setMaxSuffixComponents
```
public final Interest setMaxSuffixComponents(int maxSuffixComponents)
```
    Set the max suffix components count.
    
    Parameters:
    
    maxSuffixComponents - The max suffix components count. If not specified, set to -1.
    
    Returns:
    
    This Interest so that you can chain calls to update values.
  - setCanBePrefix
```
public final Interest setCanBePrefix(boolean canBePrefix)
```
    Set the CanBePrefix flag.
    
    Parameters:
    
    canBePrefix - True if the Interest name can be a prefix.
    
    Returns:
    
    This Interest so that you can chain calls to update values.
  - setChildSelector
```
public final Interest setChildSelector(int childSelector)
```
    Set the child selector.
    
    Parameters:
    
    childSelector - The child selector. If not specified, set to -1.
    
    Returns:
    
    This Interest so that you can chain calls to update values.
  - setMustBeFresh
```
public final Interest setMustBeFresh(boolean mustBeFresh)
```
    Set the MustBeFresh flag.
    
    Parameters:
    
    mustBeFresh - True if the content must be fresh, otherwise false. If you do not set this flag, the default value is true.
    
    Returns:
    
    This Interest so that you can chain calls to update values.
  - setInterestLifetimeMilliseconds
```
public final Interest setInterestLifetimeMilliseconds(double interestLifetimeMilliseconds)
```
    Set the interest lifetime.
    
    Parameters:
    
    interestLifetimeMilliseconds - The interest lifetime in milliseconds. If not specified, set to -1.
    
    Returns:
    
    This Interest so that you can chain calls to update values.
  - setNonce
```
public final Interest setNonce(Blob nonce)
```
    Deprecated. You should let the wire encoder generate a random nonce internally before sending the interest.
  - setKeyLocator
```
public final Interest setKeyLocator(KeyLocator keyLocator)
```
    Set this interest to use a copy of the given KeyLocator object.
    
    Parameters:
    
    keyLocator - The KeyLocator object. This makes a copy of the object. If no key locator is specified, set to a new default KeyLocator(), or to a KeyLocator with an unspecified type.
    
    Returns:
    
    This Interest so that you can chain calls to update values.
    
    Note:
    
    You can also call getKeyLocator and change the key locator directly.
  - setExclude
```
public final Interest setExclude(Exclude exclude)
```
    Set this interest to use a copy of the given Exclude object.
    
    Parameters:
    
    exclude - The Exclude object. This makes a copy of the object. If no exclude is specified, set to a new default Exclude(), or to an Exclude with size() 0.
    
    Returns:
    
    This Interest so that you can chain calls to update values.
    
    Note:
    
    You can also call getExclude and change the exclude entries directly.
  - setForwardingHint
```
public final Interest setForwardingHint(DelegationSet forwardingHint)
```
    Set this interest to use a copy of the given DelegationSet object as the forwarding hint.
    
    Parameters:
    
    forwardingHint - The DelegationSet object to use as the forwarding hint. This makes a copy of the object. If no forwarding hint is specified, set to a new default DelegationSet() with no entries.
    
    Returns:
    
    This Interest so that you can chain calls to update values.
    
    Note:
    
    You can also call getForwardingHint and change the forwarding hint directly.
  - setApplicationParameters
```
public final Interest setApplicationParameters(Blob applicationParameters)
```
    Set the application parameters to the given value.
    
    Parameters:
    
    applicationParameters - The application parameters Blob.
    
    Returns:
    
    This Interest so that you can chain calls to update values.
  - setParameters
```
public final Interest setParameters(Blob applicationParameters)
```
    Deprecated. Use setApplicationParameters.
  - appendParametersDigestToName
```
public final Interest appendParametersDigestToName()
```
    Append the digest of the application parameters to the Name as a ParametersSha256DigestComponent. However, if the application parameters is unspecified, do nothing. This does not check if the Name already has a parameters digest component, so calling again will append another component.
    
    Returns:
    
    This Interest so that you can chain calls to update values.
  - setLinkWireEncoding
```
public final Interest setLinkWireEncoding(Blob encoding,
                                          WireFormat wireFormat)
```
    Deprecated. Use setForwardingHint.
    
    Set the link wire encoding bytes, without decoding them. If there is a link object, set it to null. If you later call getLink(), it will decode the wireEncoding to create the link object.
    
    Parameters:
    
    encoding - The buffer with the bytes of the link wire encoding. If no link is specified, set to an empty Blob() or call unsetLink().
    
    wireFormat - The wire format of the encoding, to be used later if necessary to decode.
    
    Returns:
    
    This Interest so that you can chain calls to update values.
  - setLinkWireEncoding
```
public final Interest setLinkWireEncoding(Blob encoding)
```
    Deprecated. Use setForwardingHint.
    
    Set the link wire encoding bytes, without decoding them. If there is a link object, set it to null. IF you later call getLink(), it will decode the wireEncoding to create the link object.
    
    Parameters:
    
    encoding - The buffer with the bytes of the link wire encoding. If no link is specified, set to an empty Blob().
    
    Returns:
    
    This Interest so that you can chain calls to update values.
  - unsetLink
```
public final Interest unsetLink()
```
    Deprecated. Use setForwardingHint.
    
    Clear the link wire encoding and link object so that getLink() returns null.
    
    Returns:
    
    This Interest so that you can chain calls to update values.
  - setSelectedDelegationIndex
```
public final Interest setSelectedDelegationIndex(int selectedDelegationIndex)
```
    Deprecated. Use setForwardingHint.
    
    Set the selected delegation index.
    
    Parameters:
    
    selectedDelegationIndex - The selected delegation index. If not specified, set to -1.
    
    Returns:
    
    This Interest so that you can chain calls to update values.
  - refreshNonce
```
public final void refreshNonce()
```
    Update the bytes of the nonce with new random values. This ensures that the new nonce value is different than the current one. If the current nonce is not specified, this does nothing.
  - matchesName
```
public final boolean matchesName(Name name)
```
    Check if this Interest's name matches the given name (using Name.match) and the given name also conforms to the interest selectors.
    
    Parameters:
    
    name - The name to check.
    
    Returns:
    
    True if the name and interest selectors match, otherwise false.
  - matchesData
```
public final boolean matchesData(Data data,
                                 WireFormat wireFormat)
```
    Check if the given Data packet can satisfy this Interest. This method considers the Name, MinSuffixComponents, MaxSuffixComponents, PublisherPublicKeyLocator, and Exclude. It does not consider the ChildSelector or MustBeFresh. This uses the given wireFormat to get the Data packet encoding for the full Name.
    
    Parameters:
    
    data - The Data packet to check.
    
    wireFormat - A WireFormat object used to encode the Data packet to get its full Name.
    
    Returns:
    
    True if the given Data packet can satisfy this Interest.
  - matchesData
```
public final boolean matchesData(Data data)
```
    Check if the given Data packet can satisfy this Interest. This method considers the Name, MinSuffixComponents, MaxSuffixComponents, PublisherPublicKeyLocator, and Exclude. It does not consider the ChildSelector or MustBeFresh. This uses the default WireFormat to get the Data packet encoding for the full Name.
    
    Parameters:
    
    data - The Data packet to check.
    
    Returns:
    
    True if the given Data packet can satisfy this Interest.
  - getDefaultWireEncoding
```
public final SignedBlob getDefaultWireEncoding()
```
    Return a pointer to the defaultWireEncoding, which was encoded with getDefaultWireEncodingFormat().
    
    Returns:
    
    The default wire encoding. Its pointer may be null.
  - getChangeCount
```
public final long getChangeCount()
```
    Get the change count, which is incremented each time this object (or a child object) is changed.
    
    Specified by:
    
    getChangeCount in interface ChangeCountable
    
    Returns:
    
    The change count.
  - getDidSetCanBePrefix_
```
public boolean getDidSetCanBePrefix_()
```
    This internal library method gets didSetCanBePrefix_ which is set true when the application calls setCanBePrefix(), or if the application had already called setDefaultCanBePrefix() before creating the Interest.

Class Interest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CHILD_SELECTOR_LEFT

CHILD_SELECTOR_RIGHT

Constructor Detail

Interest

Interest

Interest

Interest

Interest

Method Detail

getDefaultCanBePrefix

setDefaultCanBePrefix

wireEncode

wireEncode

wireDecode

wireDecode

wireDecode

wireDecode

toUri

getName

getMinSuffixComponents

getMaxSuffixComponents

getCanBePrefix

getKeyLocator

getExclude

getChildSelector

getMustBeFresh

getInterestLifetimeMilliseconds

getNonce

getForwardingHint

hasApplicationParameters

hasParameters

getApplicationParameters

getParameters

hasLink

getLink

getLinkWireEncoding

getLinkWireEncoding

getSelectedDelegationIndex

getIncomingFaceId

setName

setMinSuffixComponents

setMaxSuffixComponents

setCanBePrefix

setChildSelector

setMustBeFresh

setInterestLifetimeMilliseconds

setNonce

setKeyLocator

setExclude

setForwardingHint

setApplicationParameters

setParameters

appendParametersDigestToName

setLinkWireEncoding

setLinkWireEncoding

unsetLink

setSelectedDelegationIndex

refreshNonce

matchesName

matchesData

matchesData

getDefaultWireEncoding

getChangeCount

getDidSetCanBePrefix_