net.named_data.jndn

Class InterestFilter

java.lang.Object

net.named_data.jndn.InterestFilter

public class InterestFilter
extends Object

An InterestFilter holds a Name prefix and optional regex match expression for use in Face.setInterestFilter.

Constructor Summary

Constructors

Constructor and Description
InterestFilter(InterestFilter interestFilter) Create an InterestFilter which is a copy of the given interestFilter.
InterestFilter(Name prefix) Create an InterestFilter to match any Interest whose name starts with the given prefix.
InterestFilter(Name prefix, String regexFilter) Create an InterestFilter to match any Interest whose name starts with the given prefix and the remaining components match the regexFilter regular expression as described in doesMatch.
InterestFilter(String prefixUri) Create an InterestFilter to match any Interest whose name starts with the given prefix.
InterestFilter(String prefixUri, String regexFilter) Create an InterestFilter to match any Interest whose name starts with the given prefix URI and the remaining components match the regexFilter regular expression as described in doesMatch.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	doesMatch(Name name) Check if the given name matches this filter.
Name	getPrefix() Get the prefix given to the constructor.
String	getRegexFilter() Get the regex filter.
boolean	hasRegexFilter() Check if a regexFilter was supplied to the constructor.

Methods inherited from class java.lang.Object

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

Constructor Detail

InterestFilter

public InterestFilter(Name prefix)

Create an InterestFilter to match any Interest whose name starts with the given prefix.

Parameters:

prefix - The prefix Name. This makes a copy of the Name.

InterestFilter

public InterestFilter(String prefixUri)

Create an InterestFilter to match any Interest whose name starts with the given prefix.

Parameters:

prefixUri - The URI of the prefix Name.

InterestFilter

public InterestFilter(Name prefix,
              String regexFilter)

Create an InterestFilter to match any Interest whose name starts with the given prefix and the remaining components match the regexFilter regular expression as described in doesMatch.

Parameters:

prefix - The prefix Name. This makes a copy of the Name.

regexFilter - The regular expression for matching the remaining name components.

InterestFilter

public InterestFilter(String prefixUri,
              String regexFilter)

Create an InterestFilter to match any Interest whose name starts with the given prefix URI and the remaining components match the regexFilter regular expression as described in doesMatch.

Parameters:

prefixUri - The URI of the prefix Name.

regexFilter - The regular expression for matching the remaining name components.

InterestFilter

public InterestFilter(InterestFilter interestFilter)

Create an InterestFilter which is a copy of the given interestFilter.

Parameters:

interestFilter - The InterestFilter with values to copy from.

Method Detail

doesMatch

public final boolean doesMatch(Name name)

Check if the given name matches this filter. Match if name starts with this filter's prefix. If this filter has the optional regexFilter then the remaining components match the regexFilter regular expression. For example, the following InterestFilter: InterestFilter("/hello", "<world><>+") will match all Interests, whose name has the prefix `/hello` which is followed by a component `world` and has at least one more component after it. Examples: /hello/world/! /hello/world/x/y/z Note that the regular expression will need to match all remaining components (e.g., there are implicit heading `^` and trailing `$` symbols in the regular expression).

Parameters:

name - The name to check against this filter.

Returns:

True if name matches this filter, otherwise false.

getPrefix

public final Name getPrefix()

Get the prefix given to the constructor.

Returns:

The prefix Name which you should not modify.

hasRegexFilter

public final boolean hasRegexFilter()

Check if a regexFilter was supplied to the constructor.

Returns:

True if a regexFilter was supplied to the constructor.

getRegexFilter

public final String getRegexFilter()

Get the regex filter. This is only valid if hasRegexFilter() is true.

Returns:

The regular expression for matching the remaining name components.