FileBlob (Carbonado 1.2.3 API)

java.lang.Object
+
- com.amazon.carbonado.lob.AbstractBlob
- +
  - com.amazon.carbonado.lob.FileBlob
  +
+

+
+
All Implemented Interfaces:
+
Blob, Lob
+
+
+
+
```
public class FileBlob
+extends AbstractBlob
```
+
Implementation of a Blob which is backed by a File.
+
Author:
+
Brian S O'Neill
+

+ +

+ + +
Constructor Summary
+ + + + + + + + +
Constructors
Constructor and Description
FileBlob(java.io.File file)
+

Constructors
Constructor and Description
`FileBlob(java.io.File file)`

+ +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`long`	`getLength()` + Returns the length of this Blob, in bytes. +
`java.lang.Object`	`getLocator()` + Always returns null. +
`java.io.InputStream`	`openInputStream()` + Returns an InputStream for reading Blob data positioned at the + start. +
`java.io.InputStream`	`openInputStream(long pos)` + Returns an InputStream for reading Blob data. +
`java.io.InputStream`	`openInputStream(long pos, + int bufferSize)` + Returns an InputStream for reading Blob data. +
`java.io.OutputStream`	`openOutputStream()` + Returns an OutputStream for writing Blob data, positioned at the + start. +
`java.io.OutputStream`	`openOutputStream(long pos)` + Returns an OutputStream for writing Blob data. +
`java.io.OutputStream`	`openOutputStream(long pos, + int bufferSize)` + Returns an OutputStream for writing Blob data. +
`void`	`setLength(long length)` + Set the length of this Blob, in bytes. +

+ + +
Methods inherited from class com.amazon.carbonado.lob.AbstractBlob
+asString, asString, asString, equals, hashCode, setValue, setValue, setValue, toString

+ + +
Methods inherited from class java.lang.Object
+clone, finalize, getClass, notify, notifyAll, wait, wait, wait

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    FileBlob
    +
```
public FileBlob(java.io.File file)
```
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    openInputStream
    +
```
public java.io.InputStream openInputStream()
+                                    throws FetchException
```
    +
    Description copied from interface: Blob
    +
    Returns an InputStream for reading Blob data positioned at the + start. The Blob implementation selects an appropriate buffer size for + the stream.
    +
    Returns:
    InputStream for this Blob, which is not guaranteed to be thread-safe
    +
    Throws:
    +
    FetchException
    +
  + + + +
  - +
    openInputStream
    +
```
public java.io.InputStream openInputStream(long pos)
+                                    throws FetchException
```
    +
    Description copied from interface: Blob
    +
    Returns an InputStream for reading Blob data. The Blob implementation + selects an appropriate buffer size for the stream.
    +
    Parameters:
    pos - desired zero-based position to read from
    +
    Returns:
    InputStream for this Blob, which is not guaranteed to be thread-safe
    +
    Throws:
    +
    FetchException
    +
  + + + +
  - +
    openInputStream
    +
```
public java.io.InputStream openInputStream(long pos,
+                                  int bufferSize)
+                                    throws FetchException
```
    +
    Description copied from interface: Blob
    +
    Returns an InputStream for reading Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob implementation.
    +
    Parameters:
    pos - desired zero-based position to read from
    bufferSize - suggest that the input stream buffer be at least this large (in bytes)
    +
    Returns:
    InputStream for this Blob, which is not guaranteed to be thread-safe
    +
    Throws:
    +
    FetchException
    +
  + + + +
  - +
    getLength
    +
```
public long getLength()
+               throws FetchException
```
    +
    Description copied from interface: Blob
    +
    Returns the length of this Blob, in bytes.
    +
    Throws:
    +
    FetchException
    +
  + + + +
  - +
    openOutputStream
    +
```
public java.io.OutputStream openOutputStream()
+                                      throws PersistException
```
    +
    Description copied from interface: Blob
    +
    Returns an OutputStream for writing Blob data, positioned at the + start. The Blob implementation selects an appropriate buffer size for + the stream.
    +
    Returns:
    OutputStream for this Blob, which is not guaranteed to be thread-safe
    +
    Throws:
    +
    PersistException
    +
  + + + +
  - +
    openOutputStream
    +
```
public java.io.OutputStream openOutputStream(long pos)
+                                      throws PersistException
```
    +
    Description copied from interface: Blob
    +
    Returns an OutputStream for writing Blob data. The Blob implementation + selects an appropriate buffer size for the stream.
    +
    Parameters:
    pos - desired zero-based position to write to
    +
    Returns:
    OutputStream for this Blob, which is not guaranteed to be thread-safe
    +
    Throws:
    +
    PersistException
    +
  + + + +
  - +
    openOutputStream
    +
```
public java.io.OutputStream openOutputStream(long pos,
+                                    int bufferSize)
+                                      throws PersistException
```
    +
    Description copied from interface: Blob
    +
    Returns an OutputStream for writing Blob data. A suggested buffer size + must be provided, but it might be ignored by the Blob implementation.
    +
    Parameters:
    pos - desired zero-based position to write to
    bufferSize - suggest that the output stream buffer be at least this large (in bytes)
    +
    Returns:
    OutputStream for this Blob, which is not guaranteed to be thread-safe
    +
    Throws:
    +
    PersistException
    +
  + + + +
  - +
    setLength
    +
```
public void setLength(long length)
+               throws PersistException
```
    +
    Description copied from interface: Blob
    +
    Set the length of this Blob, in bytes. If the new length is shorter, the + Blob is truncated. If the new length is longer, the Blob is padded with + zeros.
    +
    Parameters:
    length - new length to set to
    +
    Throws:
    +
    PersistDeniedException - if Blob is read-only
    +
    PersistException
    +
  + + + +
  - +
    getLocator
    +
```
public java.lang.Object getLocator()
```
    +
    Always returns null.
    +
  +
+

Class FileBlob

Constructor Summary

Method Summary

Methods inherited from class com.amazon.carbonado.lob.AbstractBlob

Methods inherited from class java.lang.Object

Constructor Detail

FileBlob

Method Detail

openInputStream

openInputStream

openInputStream

getLength

openOutputStream

openOutputStream

openOutputStream

setLength

getLocator