net.named_data.jndn

Class Exclude

java.lang.Object

net.named_data.jndn.Exclude

All Implemented Interfaces:

ChangeCountable

public class Exclude
extends Object
implements ChangeCountable

An Exclude holds an Array of Exclude.Entry.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Exclude.Entry An Exclude.Entry holds an Exclude.Type, and if it is a COMPONENT, it holds the component value.
static class	Exclude.Type

Constructor Summary

Constructors

Constructor and Description
Exclude() Create a new Exclude with no entries.
Exclude(Exclude exclude) Create a new Exclude as a copy of the given exclude.

Method Summary

Methods

Modifier and Type	Method and Description
Exclude	appendAny() Append a new entry of type Exclude.Type.ANY.
Exclude	appendComponent(Name.Component component) Append a new entry of type Exclude.Type.COMPONENT, taking another pointer to the Name.Component.
void	clear() Clear all the entries.
Exclude.Entry	get(int i) Get the entry at the given index.
long	getChangeCount() Get the change count, which is incremented each time this object is changed.
boolean	matches(Name.Component component) Check if the component matches any of the exclude criteria.
int	size() Get the number of entries.
String	toUri() Encode this Exclude with elements separated by "," and Exclude.Type.ANY shown as "*".

Methods inherited from class java.lang.Object

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

Constructor Detail

Exclude

public Exclude()

Create a new Exclude with no entries.

Exclude

public Exclude(Exclude exclude)

Create a new Exclude as a copy of the given exclude.

Parameters:

exclude - The Exclude to copy.

Method Detail

size

public final int size()

Get the number of entries.

Returns:

The number of entries.

get

public final Exclude.Entry get(int i)

Get the entry at the given index.

Parameters:

i - The index of the entry, starting from 0.

Returns:

The entry at the index.

appendAny

public final Exclude appendAny()

Append a new entry of type Exclude.Type.ANY.

Returns:

This Exclude so that you can chain calls to append.

appendComponent

public final Exclude appendComponent(Name.Component component)

Append a new entry of type Exclude.Type.COMPONENT, taking another pointer to the Name.Component.

Parameters:

component - The component value for the entry.

Returns:

This Exclude so that you can chain calls to append.

clear

public final void clear()

Clear all the entries.

matches

public boolean matches(Name.Component component)

Check if the component matches any of the exclude criteria.

Parameters:

component - The name component to check.

Returns:

True if the component matches any of the exclude criteria, otherwise false.

toUri

public final String toUri()

Encode this Exclude with elements separated by "," and Exclude.Type.ANY shown as "*".

Returns:

the URI string

getChangeCount

public final long getChangeCount()

Get the change count, which is incremented each time this object is changed.

Specified by:

getChangeCount in interface ChangeCountable

Returns:

The change count.