com.codemesh.terp.data
Interface Path

All Superinterfaces:

java.util.Collection<java.lang.Object>, java.lang.Iterable<java.lang.Object>, java.util.List<java.lang.Object>

All Known Implementing Classes:

Path.Impl

public interface Path
extends java.util.List<java.lang.Object>

A grouping interface for file paths, including patterns. Paths require relatively little explanation in general, they are simply ordered collections of pathroots. As such, a path can be constructed from a single file or string representing a file, from a collection or array of legal pathroots, and from a map containing a base directory and inclusion/ exclusion patterns.

This latter construction mode deserves a more detailed explanation. Let's say that you want to create a path containing all jar files in the current directory. You would simply use a map as input:

 { dir:'.', include:'*.jar', exclude:'test.jar'}
 

The exclusion is simply there to demonstrate that you don't have to accept all files of a certain pattern on the path.

Nested Class Summary

static class

Path.Impl A grouping interface for file paths, including patterns.

Field Summary

static java.lang.String	DIR
static java.lang.String	EXCLUDE
static java.lang.String	FILE
static java.lang.String	INCLUDE
static java.lang.String	PATH

Method Summary

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Field Detail

DIR

static final java.lang.String DIR

See Also:

Constant Field Values

EXCLUDE

static final java.lang.String EXCLUDE

See Also:

Constant Field Values

FILE

static final java.lang.String FILE

See Also:

Constant Field Values

INCLUDE

static final java.lang.String INCLUDE

See Also:

Constant Field Values

PATH

static final java.lang.String PATH

See Also:

Constant Field Values