View Javadoc
1   package org.codehaus.plexus.archiver;
2   
3   import javax.annotation.CheckForNull;
4   import org.codehaus.plexus.components.io.fileselectors.FileSelector;
5   import org.codehaus.plexus.components.io.functions.InputStreamTransformer;
6   
7   /**
8    * A file set is a set of files, which may be added to an
9    * archive.
10   *
11   * @since 1.0-alpha-9
12   */
13  public interface BaseFileSet
14  {
15  
16      /**
17       * Returns the prefix, which the file sets contents shall
18       * have.
19       */
20      @CheckForNull
21      String getPrefix();
22  
23      /**
24       * Returns a string of patterns, which included files
25       * should match.
26       */
27      @CheckForNull
28      String[] getIncludes();
29  
30      /**
31       * Returns a string of patterns, which excluded files
32       * should match.
33       */
34      @CheckForNull
35      String[] getExcludes();
36  
37      /**
38       * Returns, whether the include/exclude patterns are
39       * case sensitive.
40       */
41      boolean isCaseSensitive();
42  
43      /**
44       * Returns, whether the default excludes are being
45       * applied.
46       */
47      boolean isUsingDefaultExcludes();
48  
49      /**
50       * Returns, whether empty directories are being included.
51       */
52      boolean isIncludingEmptyDirectories();
53  
54      /**
55       * Returns a set of file selectors, which should be used
56       * to select the included files.
57       */
58      @CheckForNull
59      FileSelector[] getFileSelectors();
60  
61      /**
62       * Returns the InputStreamTransformers that can be applied to this fileset
63       *
64       * @return The transformers.
65       */
66      InputStreamTransformer getStreamTransformer();
67  
68  }