com.asakusafw.runtime.directio

Class FilePattern

java.lang.Object

com.asakusafw.runtime.directio.FilePattern

All Implemented Interfaces:

ResourcePattern

public class FilePattern
extends Object
implements ResourcePattern

A pattern describes file location.

Pattern Expression

expression:
    (segment "/")* segment

segment:
    traverse
    directory

traverse:
    "**" "/"

directory:
    resource "/"

file:
    resource

resource:
    token (wildcard token)* wildcard?
    wildcard (token wildcard)* token?

token:
    variable
    character+

wildcard:
    "*"

variable:
    "${" character* "}"

character:
    (any character except "/", "\", "$", "*", "?", "#", "{", "}", "[", "]")

Examples of Pattern Expression

Expression	Description
a/b/c.csv	just a/b/c.csv
*	all files in target directory
**	all files in target directory (recursive)
*.csv	all CSV files in target directory
**/*.csv	all CSV files in target directory (recursive)

Since:

0.2.5

Version:

0.7.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FilePattern.PatternElement A piece of file/directory name pattern.
static class	FilePattern.PatternElementKind Kind of FilePattern.PatternElement.
static class	FilePattern.Segment Each segment in FilePattern.
static class	FilePattern.Selection Represents a selecion.
static class	FilePattern.Variable Represents a variable.

Method Summary

Modifier and Type	Method and Description
static FilePattern	compile(String patternString) Compiles pattern expression.
boolean	containsTraverse() Returns whether this pattern contains traverse (**).
boolean	containsVariables() Returns whether this pattern contains variables (${var}).
Set<FilePattern.PatternElementKind>	getPatternElementKinds() Returns the pattern element kinds appeared in this pattern.
String	getPatternString() Returns a string which represents this pattern.
List<FilePattern.Segment>	getSegments() Returns segments of this pattern.
static FilePattern	of(List<? extends FilePattern.Segment> segments) Returns a pattern of the given segments.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getPatternElementKinds

public Set<FilePattern.PatternElementKind> getPatternElementKinds()

Returns the pattern element kinds appeared in this pattern.

Returns:

the pattern element kinds

Since:

0.7.0

containsVariables

public boolean containsVariables()

Returns whether this pattern contains variables (${var}).

Returns:

true if contains

containsTraverse

public boolean containsTraverse()

Returns whether this pattern contains traverse (**).

Returns:

true if contains

Since:

0.7.0

getSegments

public List<FilePattern.Segment> getSegments()

Returns segments of this pattern.

Returns:

the segments

getPatternString

public String getPatternString()

Returns a string which represents this pattern.

Returns:

the pattern string

toString

public String toString()

Overrides:

toString in class Object

of

public static FilePattern of(List<? extends FilePattern.Segment> segments)

Returns a pattern of the given segments.

Parameters:

segments - the pattern segments

Returns:

the pattern

Since:

0.10.0

compile

public static FilePattern compile(String patternString)

Compiles pattern expression.

Parameters:

patternString - pattern expression

Returns:

the compiled object

Throws:

IllegalArgumentException - if pattern is not valid

See Also:

Pattern Expression