Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Selectors

The IzPack fileset concept selector for the FileSet concept has been adapted from the Apache Ant Selector core type. Their The functionality has been reduced to the satisfy the needs of IzPack.

...

A selector is an element of FileSet, and appears within it. It can also be defined outside of any target by using the <selector> tag and then using it used as a reference.

Different selectors have different attributes. Some selectors can contain other selectors, and these are called Selector Containers.

...

The <contains> tag in a FileSet limits the files defined by that fileset to only those which contain the string specified by the text attribute.

Attribute

Description

Required

text

Specifies the text that every file must contain

Yes

casesensitive

Whether to pay attention to case when looking for the string in the text attribute. Default is true.

No

ignorewhitespace

Whether to eliminate whitespace before checking for the string in the text attribute. Default is false.

No

Here is an example of how to use the Contains Selector:

...

The <date> tag in a FileSet will put a limit on the files specified by the include tag, so that tags whose last modified date does not meet the date limits specified by the selector will not end up being selected.

Attribute

Description

Required

datetime

Specifies the date and time to test for. Should be in the format MM/DD/YYYY HH:MM AM_or_PM, or an alternative pattern specified via the pattern attribute.

At least one of the two.

millis

The number of milliseconds since 1970 that should be tested for. It is usually much easier to use the datetime attribute.

when

Indicates how to interpret the date, whether the files to be selected are those whose last modified times should be before, after, or equal to the specified value. Acceptable values for this attribute are:

  • before - select files whose last modified date is before the indicated date
  • after - select files whose last modified date is after the indicated date
  • equal - select files whose last modified date is this exact date
    The default is equal.

No

granularity

The number of milliseconds leeway to use when comparing file modification times. This is needed because not every file system supports tracking the last modified time to the millisecond level. Default is 0 milliseconds, or 2 seconds on DOS systems.

No

pattern

The SimpleDateFormat-compatible pattern to use when interpreting the datetime attribute.

No

checkdirs

Indicates whether or not to check dates on directories.

No, defaults to false

Here is an example of how to use the Date Selector:

...

The <depend> selector is case-sensitive.

Attribute

Description

Required

targetdir

The base directory to look for the files to compare against. The precise location depends on a combination of this attribute and the <mapper> element, if any.

Yes

granularity

The number of milliseconds leeway to give before deciding a file is out of date. This is needed because not every file system supports tracking the last modified time to the millisecond level. Default is 0 milliseconds, or 2 seconds on DOS systems.

No

Here is an example of how to use the Depend Selector:

...

The <depth> tag selects files based on how far down they are stored in the directory structure in relation to the base directory of the fileset.

Attribute

Description

Required

min

The minimum number of directory levels below the base directory that a file must be in order to be selected. Default is 0.

At least one of the two.

max

The maximum number of directory levels below the base directory that a file can be and still be selected. Default is no limit.

Here is an example of how to use the Depth Selector:

...

The <different> tag supports the use of a contained <mapper>  element to define the location of the file to be compared against. If no <mapper> element is specified, the identity type mapper is used.

Attribute

Description

Required

targetdir

The base directory to look for the files to compare against. The precise location depends on a combination of this attribute and the <mapper> element, if any.

Yes

ignoreFileTimes

Whether to use file times in the comparison or not. Default is true (time differences are ignored).

No

ignoreContents

Whether to do a byte per byte compare. Default is false (contents are compared).

No

granularity

The number of milliseconds leeway to give before deciding a file is out of date. This is needed because not every file system supports tracking the last modified time to the millisecond level. Default is 0 milliseconds, or 2 seconds on DOS systems.

No

Here is an example of how to use the Different Selector:

...

The <filename> selector is case-sensitive.

Attribute

Description

Required

name

The name of files to select. The name parameter can contain standard wildcard characters.

Yes

casesensitive

Whether to pay attention to case when looking at file names. Default is "true".

No

negate

Whether to reverse the effects of this filename selection, therefore emulating an exclude rather than include tag. Default is "false".

No

Here is an example of how to use the Filename Selector:

...

The <present> selector is case-sensitive.

Attribute

Description

Required

targetdir

The base directory to look for the files to compare against. The precise location depends on a combination of this attribute and the <mapper> element, if any.

Yes

present

Whether we are requiring that a file is present in the src directory tree only, or in both the src and the target directory tree. Valid values are:

  • srconly - select files only if they are in the src directory tree but not in the target directory tree
  • both - select files only if they are present both in the src and target directory trees
    Default is both. Setting this attribute to "srconly" is equivalent to wrapping the selector in the <not> selector container.

No

Here is an example of how to use the Present Selector:

...

The <containsregexp> tag in a FileSet limits the files defined by that fileset to only those which contain a match to the regular expression specified by the expression attribute.

Attribute

Description

Required

expression

Specifies the regular expression that must match true in every file

Yes

Here is an example of how to use the regular expression Selector:

...

The <size> tag in a FileSet will put a limit on the files specified by the include tag, so that tags which do not meet the size limits specified by the selector will not end up being selected.

Attribute

Description

Required

value

The size of the file which should be tested for.

Yes

units

The units that the value attribute is expressed in. When using the standard single letter SI designations, such as "k","M", or "G", multiples of 1000 are used. If you want to use power of 2 units, use the IEC standard: "Ki" for 1024, "Mi" for 1048576, and so on. The default is no units which means the value attribute expresses the exact number of bytes.

No

when

Indicates how to interpret the size, whether the files to be selected should be larger, smaller, or equal to that value. Acceptable values for this attribute are:

  • less - select files less than the indicated size
  • more - select files greater than the indicated size
  • equal - select files this exact size
    The default is less.

No

Here is an example of how to use the Size Selector:

...

The <type> tag selects files of a certain type: directory or regular.

Attribute

Description

Required

type

The type of file which should be tested for. Acceptable values are:

  • file - regular files
  • dir - directories

Yes

Here is an example of how to use the Type Selector to select only directories in \${src}:

...

The <majority> tag selects files provided that a majority of the contained elements also select it. Ties are dealt with as specified by the allowtie attribute.

Attribute

Description

Required

allowtie

Whether files should be selected if there are an even number of selectors selecting them as are not selecting them. Default is true.

No

Here is an example of how to use the Majority Selector:

...