Package org.codehaus.plexus.components.io.resources

Class PlexusIoFileResource

java.lang.Object

org.codehaus.plexus.components.io.resources.AbstractPlexusIoResource

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

All Implemented Interfaces:

FileInfo, ContentSupplier, FileSupplier, NameSupplier, ResourceAttributeSupplier, SizeSupplier, PlexusIoResource

Direct Known Subclasses:

PlexusIoSymlinkResource

public class PlexusIoFileResource
extends AbstractPlexusIoResource
implements ResourceAttributeSupplier, FileSupplier

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

Constructors

Modifier	Constructor	Description
protected	PlexusIoFileResource(java.io.File file, java.lang.String name, PlexusIoResourceAttributes attrs)

Method Summary

Modifier and Type	Method	Description
PlexusIoResourceAttributes	getAttributes()
java.io.InputStream	getContents()	Creates an InputStream, which may be used to read the files contents.
java.io.File	getFile()	Returns the resources file.
long	getLastModified()	Returns the date, when the resource was last modified, if known.
static java.lang.String	getName(java.io.File file)
long	getSize()	Returns the resources size, if known.
java.net.URL	getURL()	Returns an URL, which may be used to reference the resource, if possible.
boolean	isDirectory()	Returns, whether the FileInfo refers to a directory.
boolean	isExisting()	Returns, whether the resource exists.
boolean	isFile()	Returns, whether the FileInfo refers to a file.
boolean	isSymbolicLink()	Returns, whether the FileInfo refers to a symlink.

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

getName

Methods inherited from class java.lang.Object

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

Constructor Detail

PlexusIoFileResource

protected PlexusIoFileResource(@Nonnull
                               java.io.File file,
                               @Nonnull
                               java.lang.String name,
                               @Nonnull
                               PlexusIoResourceAttributes attrs)
                        throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getName

public static java.lang.String getName(java.io.File file)

getFile

@Nonnull
public java.io.File getFile()

Returns the resources file.

Specified by:

getFile in interface FileSupplier

Returns:

The file

getContents

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

Description copied from interface: PlexusIoResource

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. Please note that this InputStream is unbuffered. Clients should wrap this in a BufferedInputStream or attempt reading reasonably large chunks (8K+).

Specified by:

getContents in interface ContentSupplier

Specified by:

getContents in interface FileInfo

Specified by:

getContents in interface PlexusIoResource

Throws:

java.io.IOException

getURL

@Nonnull
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 PlexusIoResource.getContents().

Throws:

java.io.IOException

getSize

public long getSize()

Description copied from interface: PlexusIoResource

Returns the resources size, if known. Otherwise returns PlexusIoResource.UNKNOWN_RESOURCE_SIZE.

Specified by:

getSize in interface PlexusIoResource

Specified by:

getSize in interface SizeSupplier

Overrides:

getSize in class AbstractPlexusIoResource

isDirectory

public boolean isDirectory()

Description copied from interface: PlexusIoResource

Returns, whether the FileInfo refers to a directory.

Specified by:

isDirectory in interface FileInfo

Specified by:

isDirectory in interface PlexusIoResource

Overrides:

isDirectory in class AbstractPlexusIoResource

isExisting

public boolean isExisting()

Description copied from interface: PlexusIoResource

Returns, whether the resource exists.

Specified by:

isExisting in interface PlexusIoResource

Overrides:

isExisting in class AbstractPlexusIoResource

isFile

public boolean isFile()

Description copied from interface: PlexusIoResource

Returns, whether the FileInfo refers to a file.

Specified by:

isFile in interface FileInfo

Specified by:

isFile in interface PlexusIoResource

Overrides:

isFile in class AbstractPlexusIoResource

getAttributes

@Nonnull
public PlexusIoResourceAttributes getAttributes()

Specified by:

getAttributes in interface ResourceAttributeSupplier

getLastModified

public long getLastModified()

Description copied from interface: PlexusIoResource

Returns the date, when the resource was last modified, if known. Otherwise, returns PlexusIoResource.UNKNOWN_MODIFICATION_DATE.

Specified by:

getLastModified in interface PlexusIoResource

Overrides:

getLastModified in class AbstractPlexusIoResource

See Also:

File.lastModified()

isSymbolicLink

public boolean isSymbolicLink()

Description copied from interface: FileInfo

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.

Specified by:

isSymbolicLink in interface FileInfo

Overrides:

isSymbolicLink in class AbstractPlexusIoResource