org.daisy.common.file

Class Resource

java.lang.Object

org.daisy.common.file.Resource

public class Resource
extends Object

A readable resource (file) with a certain path and media type. Does not need to be stored on disk. Java counterpart of <d:file> in XProc. This class is immutable.

Field Summary

Fields

Modifier and Type	Field and Description
static String	MEDIA_TYPE_UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Resource(File from, URI path, Optional<String> mediaType)

Method Summary

Modifier and Type	Method and Description
Resource	copy(File path)
Resource	copy(URI path)
Optional<String>	getMediaType()
URI	getPath() The path as a URI.
URI	getPath(URI base) The path as a URI relative to the given base URI.
static Resource	load(byte[] data, URI path, String mediaType)
static Resource	load(File from, String mediaType)
static Resource	load(File from, URI path, String mediaType)
static Resource	load(InputStream data, URI path, String mediaType)
static Resource	load(Supplier<InputStream> data, URI path, String mediaType)
static Resource	load(URI from, String mediaType)
static Resource	load(URI from, URI path, String mediaType)
InputStream	read() Get the contents of the resource as an InputStream.
File	readAsFile() If this resource is stored on disk or was loaded from disk, return the path as a File.
Source	readAsSource() If this resource is stored on disk, return the absolute file path as a Source.
Resource	store() Store file to disk

Methods inherited from class java.lang.Object

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

Field Detail

MEDIA_TYPE_UNKNOWN

public static final String MEDIA_TYPE_UNKNOWN

Constructor Detail

Resource

protected Resource(File from,
                   URI path,
                   Optional<String> mediaType)

Method Detail

getPath

public URI getPath()

The path as a URI. May be absolute or relative.

getPath

public URI getPath(URI base)

The path as a URI relative to the given base URI.

getMediaType

public Optional<String> getMediaType()

load

public static Resource load(URI from,
                            String mediaType)

Parameters:

from - Must be an absolute, hierarchical URI with a scheme equal to "file", a non-empty path component, and undefined authority, query, and fragment components.

Throws:

IllegalArgumentException - if the URI does not point to a file on disk.

load

public static Resource load(URI from,
                            URI path,
                            String mediaType)

load

public static Resource load(File from,
                            String mediaType)

load

public static Resource load(File from,
                            URI path,
                            String mediaType)

load

public static Resource load(InputStream data,
                            URI path,
                            String mediaType)

load

public static Resource load(Supplier<InputStream> data,
                            URI path,
                            String mediaType)

Parameters:

data - data.get() is called only once.

load

public static Resource load(byte[] data,
                            URI path,
                            String mediaType)

read

public InputStream read()
                 throws IOException

Get the contents of the resource as an InputStream.

Throws:

IOException

readAsFile

public File readAsFile()
                throws UnsupportedOperationException

If this resource is stored on disk or was loaded from disk, return the path as a File. May be different from getPath() if the file was copied from an original location.

Throws:

UnsupportedOperationException

readAsSource

public Source readAsSource()
                    throws IOException

If this resource is stored on disk, return the absolute file path as a Source. Otherwise, return the data stream as a Source with a non-empty system ID.

Throws:

IOException

copy

public Resource copy(URI path)

copy

public Resource copy(File path)

store

public Resource store()
               throws IOException

Store file to disk

Throws:

IOException - if "path" does not point to a file on disk or if the file can not be written to.