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

Class PlexusIoURLResource

java.lang.Object

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

org.codehaus.plexus.components.io.resources.PlexusIoURLResource

All Implemented Interfaces:

FileInfo, ContentSupplier, NameSupplier, SizeSupplier, PlexusIoResource

public abstract class PlexusIoURLResource
extends AbstractPlexusIoResource

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	PlexusIoURLResource(String name, long lastModified, long size, boolean isFile, boolean isDirectory, boolean isExisting)

Method Summary

Modifier and Type	Method	Description
InputStream	getContents()	Creates an InputStream, which may be used to read the files contents.
String	getDescriptionForError(URL url)
abstract URL	getURL()	Returns an URL, which may be used to reference the resource, if possible.

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

getLastModified, getName, getSize, isDirectory, isExisting, isFile, isSymbolicLink

Methods inherited from class java.lang.Object

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

Constructor Details

PlexusIoURLResource

protected PlexusIoURLResource(@Nonnull
 String name,
 long lastModified,
 long size,
 boolean isFile,
 boolean isDirectory,
 boolean isExisting)

Method Details

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+).

Throws:

IOException

getDescriptionForError

public String getDescriptionForError(URL url)

getURL

public abstract URL getURL()
                    throws IOException

Description copied from interface: PlexusIoResource

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

Returns:

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

Throws:

IOException