Package org.codehaus.plexus.archiver

Interface BaseFileSet

All Known Subinterfaces:
ArchivedFileSet, FileSet
All Known Implementing Classes:
AbstractFileSet, DefaultArchivedFileSet, DefaultFileSet
public interface BaseFileSet
A file set is a set of files, which may be added to an archive.
Since:
1.0-alpha-9

  • Method Summary

    Modifier and Type
    Method
    Description
    String[]
    getExcludes()
    Returns a string of patterns, which excluded files should match.
    org.codehaus.plexus.components.io.filemappers.FileMapper[]
    getFileMappers()
    Returns a set of file mappers, which should be used to change the filename of the included files.
    org.codehaus.plexus.components.io.fileselectors.FileSelector[]
    getFileSelectors()
    Returns a set of file selectors, which should be used to select the included files.
    String[]
    getIncludes()
    Returns a string of patterns, which included files should match.
    String
    getPrefix()
    Returns the prefix, which the file sets contents shall have.
    org.codehaus.plexus.components.io.functions.InputStreamTransformer
    getStreamTransformer()
    Returns the InputStreamTransformers that can be applied to this fileset
    boolean
    isCaseSensitive()
    Returns, whether the include/exclude patterns are case-sensitive.
    boolean
    isIncludingEmptyDirectories()
    Returns, whether empty directories are being included.
    boolean
    isUsingDefaultExcludes()
    Returns, whether the default excludes are being applied.

  • Method Details

    • getPrefix

      @CheckForNull String getPrefix()
      Returns the prefix, which the file sets contents shall have.

    • getIncludes

      @CheckForNull String[] getIncludes()
      Returns a string of patterns, which included files should match.

    • getExcludes

      @CheckForNull String[] getExcludes()
      Returns a string of patterns, which excluded files should match.

    • isCaseSensitive

      boolean isCaseSensitive()
      Returns, whether the include/exclude patterns are case-sensitive.

    • isUsingDefaultExcludes

      boolean isUsingDefaultExcludes()
      Returns, whether the default excludes are being applied.

    • isIncludingEmptyDirectories

      boolean isIncludingEmptyDirectories()
      Returns, whether empty directories are being included.

    • getFileSelectors

      @CheckForNull org.codehaus.plexus.components.io.fileselectors.FileSelector[] getFileSelectors()
      Returns a set of file selectors, which should be used to select the included files.

    • getStreamTransformer

      org.codehaus.plexus.components.io.functions.InputStreamTransformer getStreamTransformer()
      Returns the InputStreamTransformers that can be applied to this fileset
      Returns:
      The transformers.

    • getFileMappers

      @CheckForNull org.codehaus.plexus.components.io.filemappers.FileMapper[] getFileMappers()
      Returns a set of file mappers, which should be used to change the filename of the included files.