edu.ucar.unidata.sruth

Class Filter

java.lang.Object

edu.ucar.unidata.sruth.Filter

All Implemented Interfaces:

Comparable<Filter>

@Immutable
public class Filter
extends Object
implements Comparable<Filter>

A filter for selecting a class of files.

The compareTo(Filter) and includes(Filter) methods have the following relationships:

 Filter A, B;
 A.includes(B) => A.compareTo(B) <= 0
 A.includes(B) && B.includes(A) <=> A.compareTo(B) == 0
 

Instances are immutable.

Author:

Steven R. Emmerson

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Filter	EVERYTHING The filter that matches everything.
static Filter	NOTHING The filter that matches nothing.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Filter that) If A, B, and C are filters, it's possible to have A.includes(C), !B.includes(C), and !A.includes(B) and yet A.compareTo(B) < 0 and B.compareTo(C) < 0.
boolean	equals(Object obj)
static Filter	getInstance(String glob) Returns an instance corresponding to a glob pattern.
int	hashCode()
protected Object	readResolve()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EVERYTHING

public static final Filter EVERYTHING

The filter that matches everything.

NOTHING

public static final Filter NOTHING

The filter that matches nothing.

Method Detail

getInstance

public static Filter getInstance(String glob)

Returns an instance corresponding to a glob pattern. The only valid metacharacter is "*", which matches zero or more characters of a name component without crossing directory boundaries.

Parameters:

glob - The the glob pattern or null, in which case NOTHING is returned.

Returns:

A filter corresponding to the glob pattern.

Throws:

IllegalArgumentException - if glob.length > 1 && glob.charAt(0) == ArchivePath.SEPARATOR.

NullPointerException - if glob == null.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(Filter that)

If A, B, and C are filters, it's possible to have A.includes(C), !B.includes(C), and !A.includes(B) and yet A.compareTo(B) < 0 and B.compareTo(C) < 0.

Specified by:

compareTo in interface Comparable<Filter>

toString

public String toString()

Overrides:

toString in class Object

readResolve

protected Object readResolve()