Package org.codehaus.plexus.components.io.fileselectors

Interface FileInfo

All Superinterfaces:
NameSupplier
All Known Subinterfaces:
PlexusIoResource
All Known Implementing Classes:
AbstractPlexusIoResource, PlexusIoFileResource, PlexusIoSymlinkResource, PlexusIoURLResource
public interface FileInfo extends NameSupplier
An object implementing this interface is passed to the file selector when the method FileSelector.isSelected(FileInfo) is invoked. This object provides information about the file to select or deselect.

  • Method Summary

    Modifier and Type
    Method
    Description
    InputStream
    getContents()
    Creates an InputStream, which may be used to read the files contents.
    String
    getName()
    Returns the resources name, which may include path components, like directory names, or something like that.
    boolean
    isDirectory()
    Returns, whether the FileInfo refers to a directory.
    boolean
    isFile()
    Returns, whether the FileInfo refers to a file.
    boolean
    isSymbolicLink()
    Returns, whether the FileInfo refers to a symlink.

  • Method Details

    • getName

      String getName()
      Returns the resources name, which may include path components, like directory names, or something like that. The resources name is expected to be a relative name and the path components must be separated by File.pathSeparator
      Specified by:
      getName in interface NameSupplier

    • getContents

      InputStream getContents() throws IOException
      Creates an InputStream, which may be used to read the files contents. This is useful, if the file selector comes to a decision based on the files contents.
      Throws:
      IOException

    • isFile

      boolean isFile()
      Returns, whether the FileInfo refers to a file. This does not necessarily mean that the underlying representation *is* a file on disk, but that this resource represents a file.

    • isDirectory

      boolean isDirectory()
      Returns, whether the FileInfo refers to a directory. This does not necessarily mean that the underlying representation *is* a directory on disk, but that this resource represents a directory.

    • isSymbolicLink

      boolean isSymbolicLink()
      Returns, whether the FileInfo refers to a symlink. This does not necessarily mean that the underlying representation *is* a symlink on disk, but that this resource represents a symlink. This method will return "false" for java versions prior to java7.