org.rapidcontext.core.data

Class Binary.BinaryFile

java.lang.Object

org.rapidcontext.core.data.Binary.BinaryFile

All Implemented Interfaces:

Binary

Enclosing interface:

Binary

public static class Binary.BinaryFile
extends java.lang.Object
implements Binary

A binary data object, encapsulating a file.

Version:

1.0

Author:

Per Cederberg

Nested Class Summary

Nested classes/interfaces inherited from interface org.rapidcontext.core.data.Binary

Binary.BinaryFile, Binary.BinaryStream, Binary.BinaryString

Constructor Summary

Constructors

Constructor and Description
BinaryFile(java.io.File file) Creates a new binary file wrapper.

Method Summary

Modifier and Type	Method and Description
long	lastModified() The last modified timestamp for the object, if known.
java.lang.String	mimeType() The MIME type of the binary data.
java.io.InputStream	openStream() Opens a new input stream for reading the data.
long	size() Returns the size (in bytes) of the binary object, if known.

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryFile

public BinaryFile(java.io.File file)

Creates a new binary file wrapper.

Parameters:

file - the file to encapsulate

Method Detail

size

public long size()

Returns the size (in bytes) of the binary object, if known.

Specified by:

size in interface Binary

Returns:

the object size (in bytes), or -1 if unknown

lastModified

public long lastModified()

The last modified timestamp for the object, if known.

Specified by:

lastModified in interface Binary

Returns:

the last modified timestamp, or zero (0) or the current system if unknown

mimeType

public java.lang.String mimeType()

The MIME type of the binary data. Use a standard opaque binary data MIME type or one based on requested file name if unknown.

Specified by:

mimeType in interface Binary

Returns:

the MIME type of the binary data

openStream

public java.io.InputStream openStream()
                               throws java.io.IOException

Opens a new input stream for reading the data. Note that this method SHOULD be possible to call several times.

Specified by:

openStream in interface Binary

Returns:

a new input stream for reading the binary data

Throws:

java.io.IOException - if the data couldn't be opened for reading