|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PlexusResource
A resource is a byte stream, possibly (but not necessarily) with additional attributes like File
, URL
, or URI
.
Method Summary | |
---|---|
java.io.File |
getFile()
Returns the resource as a file, if possible. |
java.io.InputStream |
getInputStream()
Returns the resource as an InputStream . |
java.lang.String |
getName()
Returns the resources name, if possible. |
java.net.URI |
getURI()
Returns the resources URI, if possible. |
java.net.URL |
getURL()
Returns the resources URL, if possible. |
Method Detail |
---|
java.io.InputStream getInputStream() throws java.io.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)
.
InputStream
with the resources contents, never null.
java.io.IOException
java.io.File getFile() throws java.io.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)
.
File
containing the resources contents, if available, or null.
java.io.IOException
java.net.URL getURL() throws java.io.IOException
Returns the resources URL, if possible. A resource doesn't need to have an URL.
java.io.IOException
java.net.URI getURI() throws java.io.IOException
Returns the resources URI, if possible. A resource doesn't need to have an URI.
java.io.IOException
java.lang.String getName()
URL
, the name might be created by invoking URL.toExternalForm()
. In the case of a
File
, it might be File.getPath()
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |