Package de.xima.fc.workflow
Class UrlResourceDescriptor
- java.lang.Object
-
- de.xima.fc.workflow.UrlResourceDescriptor
-
- All Implemented Interfaces:
IResourceDescriptor
,Serializable
public final class UrlResourceDescriptor extends Object implements IResourceDescriptor
ImplementsIResourceDescriptor
via anURL
.- Since:
- 7.0.0
- Author:
- XIMA MEDIA GmbH
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description UrlResourceDescriptor(URL url)
Deprecated.UrlResourceDescriptor(URL url, URI uri, Charset charset)
Creates a new resource descriptor that reads the data from the given URL.UrlResourceDescriptor(URL url, Charset charset)
Creates a new resource descriptor that reads the data from the given URL.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static IResourceDescriptor
forClasspathResource(Class<?> clazz, String path, URI uri, Charset charset)
Creates a new resource descriptor that reads the data from the given classpath.static IResourceDescriptor
forClasspathResource(Class<?> clazz, String path, Charset charset)
Creates a new resource descriptor that reads the data from the given classpath.static IResourceDescriptor
forClasspathResource(ClassLoader loader, String path, URI uri, Charset charset)
Creates a new resource descriptor that reads the data from the given classpath.static IResourceDescriptor
forClasspathResource(ClassLoader loader, String path, Charset charset)
Creates a new resource descriptor that reads the data from the given classpath.URI
getAbsoluteUri()
Charset
getCharset()
InputStream
open()
String
toString()
-
-
-
Constructor Detail
-
UrlResourceDescriptor
@Deprecated public UrlResourceDescriptor(URL url) throws URISyntaxException
Deprecated.UseUrlResourceDescriptor(URL, Charset)
. Passnull
for the charset argument for binary resources.Creates a new resource descriptor that reads the data from the given URL.- Parameters:
url
- URL pointing to the data. Must be an absolute URL.- Throws:
URISyntaxException
- When the URL is invalid.IllegalArgumentException
- When the URL is not absolute.
-
UrlResourceDescriptor
public UrlResourceDescriptor(URL url, Charset charset) throws URISyntaxException
Creates a new resource descriptor that reads the data from the given URL.- Parameters:
url
- URL pointing to the data. Must be an absolute URL.charset
- Charset for plain text resources. UseNullPointerException
for binary resources.- Throws:
URISyntaxException
- When the URL is invalid.IllegalArgumentException
- When the URL is not absolute.
-
UrlResourceDescriptor
public UrlResourceDescriptor(URL url, URI uri, Charset charset) throws URISyntaxException
Creates a new resource descriptor that reads the data from the given URL.- Parameters:
url
- URL pointing to the data. Must be an absolute URL.uri
- URI identifying to the resource, which may be different from the URL.charset
- Charset for plain text resources. UseNullPointerException
for binary resources.- Throws:
URISyntaxException
- When the URL is invalid.IllegalArgumentException
- When the URL is not absolute.
-
-
Method Detail
-
getAbsoluteUri
public URI getAbsoluteUri()
- Specified by:
getAbsoluteUri
in interfaceIResourceDescriptor
- Returns:
- An absolute URI that identifies this resource. It is an error for this to return an URI where
URI.isAbsolute()
yieldsfalse
.
-
getCharset
public Charset getCharset()
- Specified by:
getCharset
in interfaceIResourceDescriptor
- Returns:
- When this resource is a plain text resource: the charset or encoding of the text. Defaults to UTF_8.
-
open
public InputStream open() throws IOException
- Specified by:
open
in interfaceIResourceDescriptor
- Returns:
- An input stream to the content of the resource.
- Throws:
IOException
- When the resource could not be opened.
-
forClasspathResource
public static IResourceDescriptor forClasspathResource(Class<?> clazz, String path, Charset charset) throws URISyntaxException
Creates a new resource descriptor that reads the data from the given classpath.- Parameters:
clazz
- Class with a class loader for reading the resource.path
- Path of the resource. Always interpreted as an absolute path, may or may not start with a slash.charset
- Charset for plain text files.null
for binary files.- Returns:
- A new resource descriptor that reads the data from the given classpath.
- Throws:
URISyntaxException
- When no URI was given and the URL obtained from the class loader cannot be converted to a URI.IllegalArgumentException
- When the path cannot be loaded by the class loader.
-
forClasspathResource
public static IResourceDescriptor forClasspathResource(ClassLoader loader, String path, Charset charset) throws URISyntaxException
Creates a new resource descriptor that reads the data from the given classpath.- Parameters:
loader
- Class loader for reading the resource.path
- Path of the resource. Always interpreted as an absolute path, may or may not start with a slash.charset
- Charset for plain text files.null
for binary files.- Returns:
- A new resource descriptor that reads the data from the given classpath.
- Throws:
URISyntaxException
- When no URI was given and the URL obtained from the class loader cannot be converted to a URI.IllegalArgumentException
- When the path cannot be loaded by the class loader.
-
forClasspathResource
public static IResourceDescriptor forClasspathResource(Class<?> clazz, String path, URI uri, Charset charset) throws URISyntaxException
Creates a new resource descriptor that reads the data from the given classpath.- Parameters:
clazz
- Class with a class loader for reading the resource.path
- Path of the resource. Always interpreted as an absolute path, may or may not start with a slash.uri
- Identifier of the resource.charset
- Charset for plain text files.null
for binary files.- Returns:
- A new resource descriptor that reads the data from the given classpath.
- Throws:
URISyntaxException
- When no URI was given and the URL obtained from the class loader cannot be converted to a URI.IllegalArgumentException
- When the path cannot be loaded by the class loader.
-
forClasspathResource
public static IResourceDescriptor forClasspathResource(ClassLoader loader, String path, URI uri, Charset charset) throws URISyntaxException
Creates a new resource descriptor that reads the data from the given classpath.- Parameters:
loader
- Class loader for reading the resource.path
- Path of the resource. Always interpreted as an absolute path, may or may not start with a slash.uri
- Identifier of the resource.charset
- Charset for plain text files.null
for binary files.- Returns:
- A new resource descriptor that reads the data from the given classpath.
- Throws:
URISyntaxException
- When no URI was given and the URL obtained from the class loader cannot be converted to a URI.IllegalArgumentException
- When the path cannot be loaded by the class loader.
-
-