<uri-pattern>

Purpose/Function

Describes a pattern to match when qualifying paths from a listing operation. Follows the Ant pattern conventions:

* = any character up to the first path-separator
** = all characters, including path-separators

Attributes

NAME

TYPE

DEFAULT VALUE

DESCRIPTION

base

java.net.URI

(required)

the base URI for the listing; if there are includes or excludes, this should be a directory; see further supported schemes

defaultexcludes

java.lang.Boolean

null

use the default exclude patterns (see below)

caseSensitive

java.lang.Boolean

null

matching should observe case

Elements

TAG

TYPE

COUNT

DESCRIPTION

<include>

java.lang.String

0:N

if path matches this pattern, include it

<exclude>

java.lang.String

0:N

if path matches this pattern, exclude it

<includes>

java.util.List

0:1

list of patterns for inclusion (usually not used; multiple <include> elements is more common)

<excludes>

java.util.List

0:1

list of patterns for exclusion (usually not used; multiple <exclude> elements is more common)

NOTES

The default exclusion patterns are:

// Miscellaneous typical temporary files
"**/*~", "**/#*#", "**/.#*", "**/%*%", "**/._*",

// CVS
"**/CVS", "**/CVS/**", "**/.cvsignore",
			
// SCCS
"**/SCCS", "**/SCCS/**",
			
// Visual SourceSafe
"**/vssver.scc",

// Subversion
"**/.svn", "**/.svn/**",

// Mac
"**/.DS_Store"

Examples

<uri-pattern base="file:/home/arossi/file.txt"/> <!-- just a single file -->
<uri-pattern base="file:/home/arossi"> 
   <include>file.text</include>             <!-- equivalent to previous example -->
</uri-pattern>
<uri-pattern base="file:/home/arossi">
   <include>docs/*</include>                <!-- all files and directory names in the docs directory, but nothing deeper -->
</uri-pattern>
<uri-pattern base="file:/home/arossi">
   <include>docs/**</include>               <!-- the entire docs directory -->
</uri-pattern>
<uri-pattern base="file:/home/arossi">
   <include>*/doc/**</include>              <!-- everything in all doc directories one level down -->
</uri-pattern>
<uri-pattern base="file:/home/arossi">
   <include>**/doc/**</include>             <!-- everything in all doc directories anywhere -->
</uri-pattern>
<uri-pattern base="file:/home/arossi">
   <include>**</include>
   <exclude>**properties**</exclude>        <!-- everything except files or directories containing 'properties' in its name -->            
</uri-pattern>