ByteArraySakerFile

package saker.build.file

public class ByteArraySakerFile extends SakerFileBase

saker.build.file.ByteArraySakerFile

saker.build.file.SakerFileBase

java.lang.Object

saker.build.file.SakerFile

saker.build.file.FileHandle

saker.build.file.StreamWritable

SakerFile implementation with contents that is backed by a byte array.

The file takes a byte array during construction, and will return that when any content requesting methods are called. All opening methods of this file class is efficient.

Warning: This class doesn't make an internal copy of the byte array passed to it during construction. Modifying the contents of the underlying array can result in improper operation, and broken incremental builds.

Constructors

public	ByteArraySakerFile(String name) Creates a new instance with the given name and no byte contents.
public	ByteArraySakerFile(String name, ByteArrayRegion data) Creates a new instance with the given name and byte array region.
public	ByteArraySakerFile(String name, byte[] data) Creates a new instance with the given name and byte array.
public	ByteArraySakerFile(String name, byte[] data, int start, int end) Creates a new instance with the given name and range of byte array.

Methods

public ByteArrayRegion	getBytesImpl() Gets the raw byte contents of this file without implicit synchronization.
public ContentDescriptor	getContentDescriptor() Gets the content descriptor of this file.
public String	getContentImpl() Gets the string contents of this file without implicit synchronization.
public int	getEfficientOpeningMethods() Gets the efficient opening methods flag of this file.
public InputStream	openInputStreamImpl() Opens an input stream to the contents of this file without implicit synchronization.
public void	writeToStreamImpl(OutputStream os) Writes the contents of this file without implicit synchronization.

Inherited methods
From: SakerFileBase getBytes, getContent, getName, getParent, getSakerPath, openByteSource, openInputStream, remove, synchronize, synchronize, synchronizeImpl, synchronizeImpl, toString, writeTo
From: Object clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
From: SakerFile getPosixFilePermissions, getRemoteExecutionRMIWrapper, openByteSourceImpl, writeTo

public ByteArraySakerFile(String name)

Creates a new instance with the given name and no byte contents.

Generally, this constructor is not useful at all, because the created file will have no byte contents at all.

nameThe name of the file.

SakerFileBase.SakerFileBase(String)

public ByteArraySakerFile(String name, ByteArrayRegion data) throws NullPointerException

Creates a new instance with the given name and byte array region.

nameThe name of the file.

dataThe byte contents of the file.

NullPointerExceptionIf any of the arguments are null.

SakerFileBase.SakerFileBase(String)

public ByteArraySakerFile(String name, byte[] data) throws NullPointerException

Creates a new instance with the given name and byte array.

nameThe name of the file.

dataThe byte contents of the file.

NullPointerExceptionIf any of the arguments are null.

SakerFileBase.SakerFileBase(String)

public ByteArraySakerFile(String name, byte[] data, int start, int end) throws NullPointerException, IllegalArgumentException

Creates a new instance with the given name and range of byte array.

nameThe name of the file.

dataThe byte array for the file.

startThe starting offset of the byte array range. (inclusive)

endThe ending offset of the range. (exclusive)

NullPointerExceptionIf the name or array is null.

IllegalArgumentExceptionIf the specified range is out of bounds.

public ByteArrayRegion getBytesImpl()

Overridden from: SakerFile

Gets the raw byte contents of this file without implicit synchronization.

See SakerFile.getBytes().

The byte contents of this file.

public ContentDescriptor getContentDescriptor()

Overridden from: SakerFile

Gets the content descriptor of this file.

See ContentDescriptor. Content descriptors are used to determine if the file contents need to be persisted to the file system.

Subclasses should note that if they use posix file permissions then they should return a content descriptor that reflects this behaviour. They are recommended to use PosixFilePermissionsDelegateContentDescriptor to construct the actual content descriptor.

The content descriptor. Never null.

public String getContentImpl() throws IOException

Overridden from: SakerFile

Gets the string contents of this file without implicit synchronization.

See SakerFile.getContent().

The string contents.

IOExceptionIn case of I/O error.

public int getEfficientOpeningMethods()

Overridden from: SakerFile

Gets the efficient opening methods flag of this file.

An opening method is considered (performance-wise) efficient if it generally takes less resources (time and memory) to call the appropriate content method instead of trying to employ caching to the disk.

If an opening method is reported as efficient, then the implicit synchronizations will not take place specified by the documentation of SakerFile interface.

If an opening method is not reported as efficient, then calling content retrieval methods which do not end with Impl will check if the file system already has the contents of this file persisted, and will read the contents from there if it has. If not, then the contents will be synchronized with to the disk, and the contents will be retrieved in the most efficient manner. (This manner depends on the nature of the opening method.)

The default implementation returns SakerFile.OPENING_METHODS_NONE.

The efficient opening methods.

SakerFile.OPENING_METHOD_WRITETOSTREAM

SakerFile.OPENING_METHOD_OPENINPUTSTREAM

SakerFile.OPENING_METHOD_GETBYTES

SakerFile.OPENING_METHOD_GETCONTENTS

public InputStream openInputStreamImpl() throws IOException

Overridden from: SakerFile

Opens an input stream to the contents of this file without implicit synchronization.

See SakerFile.openInputStream().

The opened input stream.

IOExceptionIn case of I/O error.