org.codehaus.plexus.components.io.resources
Class PlexusIoFileResource

java.lang.Object
  org.codehaus.plexus.components.io.resources.AbstractPlexusIoResource
      org.codehaus.plexus.components.io.resources.AbstractPlexusIoResourceWithAttributes
          org.codehaus.plexus.components.io.resources.PlexusIoFileResource

All Implemented Interfaces:

FileInfo, PlexusIoResource, PlexusIoResourceWithAttributes

public class PlexusIoFileResource

extends AbstractPlexusIoResourceWithAttributes

implements PlexusIoResourceWithAttributes

Implementation of PlexusIoResource for files.

Field Summary

Fields inherited from interface org.codehaus.plexus.components.io.resources.PlexusIoResource

UNKNOWN_MODIFICATION_DATE, UNKNOWN_RESOURCE_SIZE

Constructor Summary

PlexusIoFileResource()
Creates a new instance.

PlexusIoFileResource(java.io.File file)
Creates a new instance.

PlexusIoFileResource(java.io.File file, PlexusIoResourceAttributes attrs)
Creates a new instance.

PlexusIoFileResource(java.io.File file, java.lang.String name)
Creates a new instance.

PlexusIoFileResource(java.io.File file, java.lang.String name, PlexusIoResourceAttributes attrs)

Method Summary

java.io.InputStream	getContents() Creates an InputStream, which may be used to read the files contents.
java.io.File	getFile() Returns the resources file.
java.net.URL	getURL() Returns an URL, which may be used to reference the resource, if possible.
void	setFile(java.io.File file) Sets the resources file.

Methods inherited from class org.codehaus.plexus.components.io.resources.AbstractPlexusIoResourceWithAttributes

getAttributes, setAttributes

Methods inherited from class org.codehaus.plexus.components.io.resources.AbstractPlexusIoResource

getLastModified, getName, getSize, isDirectory, isExisting, isFile, setDirectory, setExisting, setFile, setLastModified, setName, setSize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.codehaus.plexus.components.io.resources.PlexusIoResourceWithAttributes

getAttributes, setAttributes

Methods inherited from interface org.codehaus.plexus.components.io.resources.PlexusIoResource

getLastModified, getSize, isExisting

Methods inherited from interface org.codehaus.plexus.components.io.fileselectors.FileInfo

getName, isDirectory, isFile

Constructor Detail

PlexusIoFileResource

public PlexusIoFileResource()

Creates a new instance.

PlexusIoFileResource

public PlexusIoFileResource(java.io.File file)

Creates a new instance.

PlexusIoFileResource

public PlexusIoFileResource(java.io.File file,
                            PlexusIoResourceAttributes attrs)

Creates a new instance.

PlexusIoFileResource

public PlexusIoFileResource(java.io.File file,
                            java.lang.String name)

Creates a new instance.

PlexusIoFileResource

public PlexusIoFileResource(java.io.File file,
                            java.lang.String name,
                            PlexusIoResourceAttributes attrs)

Method Detail

setFile

public void setFile(java.io.File file)

Sets the resources file.

getFile

public java.io.File getFile()

Returns the resources file.

getContents

public java.io.InputStream getContents()
                                throws java.io.IOException

Description copied from interface: FileInfo

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.

Specified by:

getContents in interface FileInfo

Throws:

java.io.IOException

getURL

public java.net.URL getURL()
                    throws java.io.IOException

Description copied from interface: PlexusIoResource

Returns an URL, which may be used to reference the resource, if possible.

Specified by:

getURL in interface PlexusIoResource

Returns:

An URL referencing the resource, if possible, or null. In the latter case, you are forced to use #getInputStream().

Throws:

java.io.IOException