org.codehaus.plexus.resource

Interface PlexusResource

All Known Implementing Classes:

FilePlexusResource, URLPlexusResource

public interface PlexusResource

A resource is a byte stream, possibly (but not necessarily) with additional attributes like File, URL , or URI.

Since:

1.0-alpha-5

Method Summary

Modifier and Type	Method and Description
File	getFile() Returns the resource as a file, if possible.
InputStream	getInputStream() Returns the resource as an InputStream.
String	getName() Returns the resources name, if possible.
URI	getURI() Returns the resources URI, if possible.
URL	getURL() Returns the resources URL, if possible.

Method Detail

getInputStream

InputStream getInputStream()
                    throws IOException

Returns the resource as an InputStream. In general, you should not assume, that this method may me called more than once. In typical cases (for example, if the Resource is backed by a file or loaded through the classpath), one may create an InputStream as often as is necessary. However, you should think of cases like an URL pointing to a servlet, where the resource contents change with every call.

If you need a reliable way of reloading the resource more than once, then you should use ResourceManager.getResourceAsFile(PlexusResource).

Returns:

An InputStream with the resources contents, never null.

Throws:

IOException

getFile

File getFile()
      throws IOException

Returns the resource as a file, if possible. A resource doesn't need to be available as a file: If you require a file, use ResourceManager.getResourceAsFile(PlexusResource).

Returns:

A File containing the resources contents, if available, or null.

Throws:

IOException

getURL

URL getURL()
    throws IOException

Returns the resources URL, if possible. A resource doesn't need to have an URL.

Returns:

The resources URL, if available, or null.

Throws:

IOException

getURI

URI getURI()
    throws IOException

Returns the resources URI, if possible. A resource doesn't need to have an URI.

Returns:

The resources URI, if available, or null.

Throws:

IOException

getName

String getName()

Returns the resources name, if possible. A resources name is a relatively unspecified thing. For example, if the resource has an URL, the name might be created by invoking URL.toExternalForm(). In the case of a File, it might be File.getPath().