org.codehaus.plexus.components.io.resources.proxy

Class PlexusIoProxyResource

java.lang.Object

org.codehaus.plexus.components.io.resources.proxy.PlexusIoProxyResource

All Implemented Interfaces:

FileInfo, PlexusIoResource

Direct Known Subclasses:

PlexusIoProxyResourceWithAttributes

public class PlexusIoProxyResource
extends Object
implements PlexusIoResource

Field Summary

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

UNKNOWN_MODIFICATION_DATE, UNKNOWN_RESOURCE_SIZE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PlexusIoProxyResource(PlexusIoResource plexusIoResource)

Method Summary

Methods

Modifier and Type	Method and Description
InputStream	getContents() Creates an InputStream, which may be used to read the files contents.
long	getLastModified() Returns the date, when the resource was last modified, if known.
String	getName() Returns the resources name, which may include path components, like directory names, or something like that.
long	getSize() Returns the resources size, if known.
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 java.lang.Object

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

Constructor Detail

PlexusIoProxyResource

protected PlexusIoProxyResource(@Nonnull
                     PlexusIoResource plexusIoResource)

Method Detail

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

See Also:

File.lastModified()

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

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

isExisting

public boolean isExisting()

Description copied from interface: PlexusIoResource

Returns, whether the resource exists.

Specified by:

isExisting in interface PlexusIoResource

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

getURL

public URL getURL()
           throws 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:

IOException

getContents

@Nonnull
public InputStream getContents()
                        throws 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 FileInfo

Specified by:

getContents in interface PlexusIoResource

Throws:

IOException

getName

public String getName()

Description copied from interface: FileInfo

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 FileInfo

isSymbolicLink

public boolean isSymbolicLink()

Description copied from interface: FileInfo

Returns, whether the FileInfo refers to a symlink. This method will return "false" for java versions prior to java7.

Specified by:

isSymbolicLink in interface FileInfo