Module de.bernd_michaely.common.io.random

Package de.bernd_michaely.common.io.random

Class RandomAccessDataFactory

java.lang.Object

de.bernd_michaely.common.io.random.RandomAccessDataFactory

public class RandomAccessDataFactory
extends Object

Factory class to create instances of objects implementing the RandomAccessData interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RandomAccessDataFactory.AccessType	This enum describes different methods to access files through a RandomAccessData interface.

Method Summary

Modifier and Type	Method	Description
static RandomAccessData	createInstance(byte[] bytes)	Creates a byte array based instance of a RandomAccessData type.
static RandomAccessData	createInstance(RandomAccessData data, long offset, long length)	Creates a RandomAccessData source for accessing a limited area of an underlying RandomAccessData source.
static RandomAccessData	createInstance(File file, RandomAccessDataFactory.AccessType accessType)	Creates a File based instance of a RandomAccessData type.
static RandomAccessData	createInstance(Path file)	Creates a FileChannel based instance of a RandomAccessData type from a Path.

Methods inherited from class java.lang.Object

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

Method Detail

createInstance

public static RandomAccessData createInstance(File file,
                                              RandomAccessDataFactory.AccessType accessType)
                                       throws RandomAccessDataException

Creates a File based instance of a RandomAccessData type.

Parameters:

file - the file to access

accessType - the file access type (a null value defaults to RandomAccessDataFactory.AccessType.RANDOM)

Returns:

a new RandomAccessData instance

Throws:

RandomAccessDataException - if file could not be read

Since:

2.0

createInstance

public static RandomAccessData createInstance(byte[] bytes)
                                       throws RandomAccessDataException

Creates a byte array based instance of a RandomAccessData type.

Parameters:

bytes - the byte array containing the data to read

Returns:

a new RandomAccessData instance

Throws:

RandomAccessDataException - if argument is null

createInstance

public static RandomAccessData createInstance(RandomAccessData data,
                                              long offset,
                                              long length)
                                       throws RandomAccessDataException

Creates a RandomAccessData source for accessing a limited area of an underlying RandomAccessData source. The current offset is initially adapted according to the source data's current offset.

Parameters:

data - the source data (null will be treated like closed)

offset - the offset to the data source

length - the length within the data source

Returns:

a new RandomAccessData instance

Throws:

RandomAccessDataException - passed through errors by accessing data

IllegalArgumentException - if offset or length is negative

Since:

2.0

createInstance

public static RandomAccessData createInstance(Path file)
                                       throws RandomAccessDataException

Creates a FileChannel based instance of a RandomAccessData type from a Path.

Parameters:

file - the file to access

Returns:

a new RandomAccessData instance

Throws:

RandomAccessDataException - if file could not be read