Modifier and Type | Method and Description |
---|---|
Location |
LocationCache.cachedLocation(Location source)
Gets the cache location of a given data source.
|
Location |
DiskLocationCache.cachedLocation(Location source) |
Location |
Download.destination() |
Location |
Download.source() |
Modifier and Type | Method and Description |
---|---|
Class<Location> |
MultiWriteHandle.getType() |
Modifier and Type | Method and Description |
---|---|
Location |
LocationCache.cachedLocation(Location source)
Gets the cache location of a given data source.
|
Location |
DiskLocationCache.cachedLocation(Location source) |
boolean |
LocationCache.canCache(Location source)
Gets whether the given location can be cached by this cache.
|
boolean |
DiskLocationCache.canCache(Location source) |
Download |
DownloadService.download(Location source,
Location destination)
Downloads data from the given source, storing it into the given
destination.
|
Download |
DefaultDownloadService.download(Location source,
Location destination) |
Download |
DownloadService.download(Location source,
Location destination,
LocationCache cache)
Downloads data from the given source, storing it into the given
destination.
|
Download |
DefaultDownloadService.download(Location source,
Location destination,
LocationCache cache) |
String |
LocationCache.loadChecksum(Location source)
Loads the checksum value which corresponds to the cached location.
|
String |
DiskLocationCache.loadChecksum(Location source) |
void |
LocationCache.saveChecksum(Location source,
String checksum)
Associates the given checksum value with the specified source location.
|
void |
DiskLocationCache.saveChecksum(Location source,
String checksum) |
Modifier and Type | Method and Description |
---|---|
default Class<Location> |
TypedIOService.getType() |
default Class<Location> |
IOService.getType() |
default Class<Location> |
IOPlugin.getType() |
Modifier and Type | Method and Description |
---|---|
boolean |
TypedIOService.canOpen(Location source) |
boolean |
AbstractTypedIOService.canOpen(Location source) |
boolean |
TypedIOService.canSave(D data,
Location destination) |
boolean |
AbstractTypedIOService.canSave(D data,
Location destination) |
default IOPlugin<D> |
TypedIOService.getOpener(Location source)
Gets the most appropriate
IOPlugin for opening data from the given
location. |
default IOPlugin<?> |
IOService.getOpener(Location source)
Gets the most appropriate
IOPlugin for opening data from the given
location. |
default IOPlugin<D> |
TypedIOService.getSaver(D data,
Location destination)
Gets the most appropriate
IOPlugin for saving data to the given
location. |
default <D> IOPlugin<D> |
IOService.getSaver(D data,
Location destination)
Gets the most appropriate
IOPlugin for saving data to the given
location. |
D |
TypedIOService.open(Location source)
Loads data from the given location.
|
default Object |
IOService.open(Location source)
Loads data from the given location.
|
default D |
IOPlugin.open(Location source)
Opens data from the given location.
|
Object |
DefaultIOService.open(Location source) |
D |
AbstractTypedIOService.open(Location source) |
void |
TypedIOService.save(D data,
Location destination)
Saves data to the given location.
|
default void |
IOPlugin.save(D data,
Location destination)
Saves the given data to the specified location.
|
void |
AbstractTypedIOService.save(D data,
Location destination) |
default void |
IOService.save(Object data,
Location destination)
Saves data to the given location.
|
void |
DefaultIOService.save(Object data,
Location destination) |
default boolean |
IOPlugin.supportsOpen(Location source)
Checks whether the I/O plugin can open data from the given location.
|
default boolean |
IOPlugin.supportsSave(Location destination)
Checks whether the I/O plugin can save data to the given location.
|
default boolean |
IOPlugin.supportsSave(Object data,
Location destination) |
Modifier and Type | Method and Description |
---|---|
Location |
IOEvent.getLocation()
Gets the data location (source or destination).
|
Constructor and Description |
---|
DataOpenedEvent(Location location,
Object data) |
DataSavedEvent(Location destination,
Object data) |
IOEvent(Location location,
Object data) |
Modifier and Type | Class and Description |
---|---|
class |
AbstractDataHandle<L extends Location>
Abstract base class for
DataHandle plugins. |
class |
AbstractHigherOrderHandle<L extends Location>
Abstract superclass for
DataHandle s that operate over other
DataHandle s. |
class |
AbstractSeekableStreamHandle<L extends Location> |
class |
AbstractStreamHandle<L extends Location>
Abstract base class for
StreamHandle implementations. |
interface |
DataHandle<L extends Location>
A data handle is a plugin which provides both streaming and random
access to bytes at a
Location (e.g., files or arrays). |
class |
DataHandleInputStream<L extends Location>
InputStream backed by a DataHandle . |
class |
DataHandleOutputStream<L extends Location>
OutputStream backed by a DataHandle . |
interface |
ResettableStreamHandle<L extends Location>
|
interface |
SeekableStreamHandle<L extends Location>
|
interface |
StreamHandle<L extends Location>
|
Modifier and Type | Method and Description |
---|---|
default Class<DataHandle<Location>> |
DataHandleService.getPluginType() |
default Class<Location> |
DataHandleService.getType() |
default DataHandle<Location> |
DataHandleService.readBuffer(DataHandle<Location> handle)
Wraps the provided
DataHandle in a read-only buffer for accelerated
reading. |
default DataHandle<Location> |
DataHandleService.readBuffer(Location location)
Creates a
DataHandle on the provided Location wrapped in a
read-only buffer for accelerated reading. |
default DataHandle<Location> |
DataHandleService.writeBuffer(DataHandle<Location> handle)
Wraps the provided
DataHandle in a write-only buffer for
accelerated writing. |
Modifier and Type | Method and Description |
---|---|
default boolean |
DataHandleService.exists(Location location)
Convenience method to test whether it describes an existing file.
|
default DataHandle<Location> |
DataHandleService.readBuffer(Location location)
Creates a
DataHandle on the provided Location wrapped in a
read-only buffer for accelerated reading. |
Modifier and Type | Method and Description |
---|---|
static long |
DataHandles.copy(DataHandle<Location> in,
DataHandle<Location> out)
Copies all bytes from the input to the output handle.
|
static long |
DataHandles.copy(DataHandle<Location> in,
DataHandle<Location> out)
Copies all bytes from the input to the output handle.
|
static long |
DataHandles.copy(DataHandle<Location> in,
DataHandle<Location> out,
int length)
Copies up to
length bytes from the input to the output handle. |
static long |
DataHandles.copy(DataHandle<Location> in,
DataHandle<Location> out,
int length)
Copies up to
length bytes from the input to the output handle. |
static long |
DataHandles.copy(DataHandle<Location> in,
DataHandle<Location> out,
long length,
Task task)
Copies up to
length bytes from the input to the output handle,
reporting the progress to the provided task. |
static long |
DataHandles.copy(DataHandle<Location> in,
DataHandle<Location> out,
long length,
Task task)
Copies up to
length bytes from the input to the output handle,
reporting the progress to the provided task. |
static long |
DataHandles.copy(DataHandle<Location> in,
DataHandle<Location> out,
long length,
Task task,
int bufferSize)
Copies up to
length bytes from the input to the output handle,
reporting the progress to the provided task. |
static long |
DataHandles.copy(DataHandle<Location> in,
DataHandle<Location> out,
long length,
Task task,
int bufferSize)
Copies up to
length bytes from the input to the output handle,
reporting the progress to the provided task. |
static long |
DataHandles.copy(DataHandle<Location> in,
DataHandle<Location> out,
Task task)
Copies all bytes from the input to the output handle, reporting the
progress to the provided task.
|
static long |
DataHandles.copy(DataHandle<Location> in,
DataHandle<Location> out,
Task task)
Copies all bytes from the input to the output handle, reporting the
progress to the provided task.
|
default DataHandle<Location> |
DataHandleService.readBuffer(DataHandle<Location> handle)
Wraps the provided
DataHandle in a read-only buffer for accelerated
reading. |
default DataHandle<Location> |
DataHandleService.writeBuffer(DataHandle<Location> handle)
Wraps the provided
DataHandle in a write-only buffer for
accelerated writing. |
Constructor and Description |
---|
ReadBufferDataHandle(DataHandle<Location> handle)
Creates a
ReadBufferDataHandle wrapping the provided handle using the
default values for the size of the pages ( byte)
and number of pages (ReadBufferDataHandle.DEFAULT_NUM_PAGES ). |
ReadBufferDataHandle(DataHandle<Location> handle,
int pageSize)
Creates a
ReadBufferDataHandle wrapping the provided handle using the
default value for the number of pages (ReadBufferDataHandle.DEFAULT_NUM_PAGES ). |
ReadBufferDataHandle(DataHandle<Location> handle,
int pageSize,
int numPages)
Creates a
ReadBufferDataHandle wrapping the provided handle. |
WriteBufferDataHandle(DataHandle<Location> handle)
Creates a
WriteBufferDataHandle that wraps the given
DataHandle , the default size for the buffer is used
( bytes). |
WriteBufferDataHandle(DataHandle<Location> handle,
int bufferSize)
Creates a
WriteBufferDataHandle that wraps the given
DataHandle |
Modifier and Type | Class and Description |
---|---|
class |
HTTPLocation
A
Location that can be accessed via HTTP. |
Modifier and Type | Method and Description |
---|---|
Location |
HTTPLocationResolver.resolve(URI uri) |
Modifier and Type | Interface and Description |
---|---|
interface |
BrowsableLocation
A
Location that offers methods to browse other locations relative to
it. |
interface |
RemoteLocation
A
Location which resides on a remote machine. |
Modifier and Type | Class and Description |
---|---|
class |
AbstractLocation
Abstract base class for
Location implementations. |
class |
AbstractRemoteLocation
Abstract base class for
RemoteLocation implementations. |
class |
BytesLocation
|
class |
DummyLocation
Location backed by nothing whatsoever. |
class |
FileLocation
|
class |
URILocation
|
class |
URLLocation
|
Modifier and Type | Method and Description |
---|---|
default Location |
LocationService.resolve(String uriString)
|
default Location |
LocationService.resolve(URI uri)
Resolves the given
URI to a location. |
Location |
LocationResolver.resolve(URI uri)
|
Location |
FileLocationResolver.resolve(URI uri) |
Modifier and Type | Method and Description |
---|---|
String |
ScriptIOPlugin.open(Location source) |
boolean |
ScriptIOPlugin.supportsOpen(Location source) |
Modifier and Type | Method and Description |
---|---|
GenericTable |
DefaultTableIOPlugin.open(Location source,
TableIOOptions options) |
void |
DefaultTableIOPlugin.save(Table table,
Location destination,
TableIOOptions options) |
boolean |
DefaultTableIOPlugin.supportsOpen(Location source) |
boolean |
DefaultTableIOPlugin.supportsSave(Location source) |
Modifier and Type | Method and Description |
---|---|
boolean |
DefaultTableIOService.canOpen(Location source) |
default Table<?,?> |
TableIOService.open(Location source) |
default Table<?,?> |
TableIOPlugin.open(Location source) |
Table<?,?> |
TableIOService.open(Location source,
TableIOOptions options) |
default Table<?,?> |
TableIOPlugin.open(Location source,
TableIOOptions options)
Opens data from the given source.
|
Table<?,?> |
DefaultTableIOService.open(Location source,
TableIOOptions options) |
default void |
TableIOService.save(Table<?,?> table,
Location destination) |
void |
TableIOService.save(Table<?,?> table,
Location destination,
TableIOOptions options) |
default void |
TableIOPlugin.save(Table<?,?> data,
Location destination,
TableIOOptions options)
Saves the given data to the specified destination.
|
void |
DefaultTableIOService.save(Table<?,?> table,
Location destination,
TableIOOptions options) |
default void |
TableIOPlugin.save(Table data,
Location destination) |
Modifier and Type | Method and Description |
---|---|
String |
TextIOPlugin.open(Location source) |
boolean |
TextIOPlugin.supportsOpen(Location source) |
Copyright © 2015–2022 SciJava. All rights reserved.