Package de.xima.fc.workflow

Class PathResourceDescriptor

java.lang.Object

de.xima.fc.workflow.PathResourceDescriptor

All Implemented Interfaces:

IResourceDescriptor, Serializable

public final class PathResourceDescriptor
extends Object
implements IResourceDescriptor

Implements IResourceDescriptor by reading data from a file.

Since:

8.1.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
static PathResourceDescriptor	fromFile(File file, Charset charset, OpenOption... openOptions)	Creates a new resource descriptor that reads data from the given file.
static PathResourceDescriptor	fromPath(Path path, Charset charset, OpenOption... openOptions)	Creates a new resource descriptor that reads data from the given file.
URI	getAbsoluteUri()
Charset	getCharset()
InputStream	open()

Methods inherited from class java.lang.Object

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

Method Detail

fromPath

public static PathResourceDescriptor fromPath(Path path,
                                              Charset charset,
                                              OpenOption... openOptions)

Creates a new resource descriptor that reads data from the given file.

Parameters:

path - File path.

charset - Charset to use for reading the file.

openOptions - Optional options for how the file is opened.

Returns:

A resource descriptor that reads from the given file.

fromFile

public static PathResourceDescriptor fromFile(File file,
                                              Charset charset,
                                              OpenOption... openOptions)

Creates a new resource descriptor that reads data from the given file.

Parameters:

file - File path.

charset - Charset to use for reading the file.

openOptions - Optional options for how the file is opened.

Returns:

A resource descriptor that reads from the given file.

getAbsoluteUri

public URI getAbsoluteUri()

Specified by:

getAbsoluteUri in interface IResourceDescriptor

Returns:

An absolute URI that identifies this resource. It is an error for this to return an URI where URI.isAbsolute() yields false.

open

public InputStream open()
                 throws IOException

Specified by:

open in interface IResourceDescriptor

Returns:

An input stream to the content of the resource.

Throws:

IOException - When the resource could not be opened.

getCharset

public Charset getCharset()

Specified by:

getCharset in interface IResourceDescriptor

Returns:

When this resource is a plain text resource: the charset or encoding of the text. Defaults to UTF_8.