com.marklogic.client.io

Class FileHandle

java.lang.Object

com.marklogic.client.impl.HandleImplementation<R,W>

com.marklogic.client.io.BaseHandle<java.io.File,java.io.File>

com.marklogic.client.io.FileHandle

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, AbstractWriteHandle, BinaryReadHandle, BinaryWriteHandle, BufferableContentHandle<java.io.File,java.io.File>, BufferableHandle, ContentHandle<java.io.File>, CtsQueryWriteHandle, DocumentMetadataReadHandle, DocumentMetadataWriteHandle, DocumentPatchHandle, GenericReadHandle, GenericWriteHandle, JSONReadHandle, JSONWriteHandle, QuadsWriteHandle, QueryOptionsListReadHandle, QueryOptionsReadHandle, QueryOptionsWriteHandle, ResendableContentHandle<java.io.File,java.io.File>, RuleListReadHandle, RuleReadHandle, RuleWriteHandle, SearchReadHandle, SPARQLResultsReadHandle, StructureReadHandle, StructureWriteHandle, TextReadHandle, TextWriteHandle, TriplesReadHandle, TriplesWriteHandle, TuplesReadHandle, ValuesListReadHandle, ValuesReadHandle, XMLReadHandle, XMLWriteHandle

public class FileHandle
extends BaseHandle<java.io.File,java.io.File>
implements ResendableContentHandle<java.io.File,java.io.File>, BinaryReadHandle, BinaryWriteHandle, GenericReadHandle, GenericWriteHandle, JSONReadHandle, JSONWriteHandle, TextReadHandle, TextWriteHandle, XMLReadHandle, XMLWriteHandle, StructureReadHandle, StructureWriteHandle, CtsQueryWriteHandle, QuadsWriteHandle, TriplesReadHandle, TriplesWriteHandle

A File Handle represents document content as a file for reading or writing. When you read a database document into a file handle, the API creates a temporary file. You can then open the file or move it with the File.renameTo() method. When writing JSON, text, or XML content, you should use a File only if the file is encoded in UTF-8. If the characters have a different encoding, use a ReaderHandle and specify the correct character encoding for the file when creating the Reader.

Field Summary

Fields inherited from interface com.marklogic.client.document.ContentDescriptor

UNKNOWN_LENGTH

Constructor Summary

Constructors

Constructor and Description
FileHandle() Zero-argument constructor.
FileHandle(java.io.File content) Initializes the handle with a file containing the content.

Method Summary

Modifier and Type	Method and Description
java.io.File	bytesToContent(byte[] buffer) Converts a byte serialization to the content representation.
byte[]	contentToBytes(java.io.File content) Converts the content representation to bytes.
void	fromBuffer(byte[] buffer) Sets the content of the handle by copying from a byte array buffer encoded in UTF-8.
java.io.File	get() Returns the file for the handle content.
java.lang.Class<java.io.File>	getContentClass() Returns the class of the handled content, which may be a base class of the actual class of a content object.
java.io.File[]	newArray(int length) Constructs an array for the handled content representation
static ContentHandleFactory	newFactory() Creates a factory to create a FileHandle for a file.
FileHandle	newHandle() Constructs a new handle for the same content representation, initializing the new handle with the same format and mime type.
FileHandle[]	newHandleArray(int length) Constructs an uninitialized array with the specified length with items of the same content representation.
protected java.lang.Class<java.io.File>	receiveAs()
protected void	receiveContent(java.io.File content)
protected java.io.File	sendContent()
void	set(java.io.File content) Assigns a file as the content.
byte[]	toBuffer() Copies the content of the handle to a byte array buffer encoded in UTF-8.
java.io.File	toContent(java.io.File serialization) Converts the serialization to the content representation.
FileHandle	with(java.io.File content) Assigns a file as the content and returns the handle as a fluent convenience.
FileHandle	withFormat(Format format) Specifies the format of the content and returns the handle as a fluent convenience.
FileHandle	withMimetype(java.lang.String mimetype) Specifies the mime type of the content and returns the handle as a fluent convenience.

Methods inherited from class com.marklogic.client.io.BaseHandle

getByteLength, getFormat, getMimetype, getServerTimestamp, setByteLength, setFormat, setMimetype, setServerTimestamp

Methods inherited from class com.marklogic.client.impl.HandleImplementation

getPointInTimeQueryTimestamp, isResendable, setPointInTimeQueryTimestamp, setResendable, setResponseServerTimestamp

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.marklogic.client.io.marker.ResendableContentHandle

newHandle, resendableHandleFor

Methods inherited from interface com.marklogic.client.io.marker.BufferableContentHandle

resendableHandleFor

Constructor Detail

FileHandle

public FileHandle()

Zero-argument constructor.

FileHandle

public FileHandle(java.io.File content)

Initializes the handle with a file containing the content.

Parameters:

content - the file

Method Detail

newFactory

public static ContentHandleFactory newFactory()

Creates a factory to create a FileHandle for a file.

Returns:

the factory

get

public java.io.File get()

Returns the file for the handle content.

Specified by:

get in interface ContentHandle<java.io.File>

Returns:

the file

set

public void set(java.io.File content)

Assigns a file as the content.

Specified by:

set in interface ContentHandle<java.io.File>

Parameters:

content - the file

with

public FileHandle with(java.io.File content)

Assigns a file as the content and returns the handle as a fluent convenience.

Parameters:

content - the file

Returns:

this handle

getContentClass

public java.lang.Class<java.io.File> getContentClass()

Description copied from interface: ContentHandle

Returns the class of the handled content, which may be a base class of the actual class of a content object. Note that implementations should override the default method, which returns null if the handle doesn't have any content.

Specified by:

getContentClass in interface ContentHandle<java.io.File>

Returns:

the class for the handled content

newHandle

public FileHandle newHandle()

Description copied from interface: ContentHandle

Constructs a new handle for the same content representation, initializing the new handle with the same format and mime type.

Specified by:

newHandle in interface BufferableContentHandle<java.io.File,java.io.File>

Specified by:

newHandle in interface ContentHandle<java.io.File>

Specified by:

newHandle in interface ResendableContentHandle<java.io.File,java.io.File>

Returns:

the new handle

newHandleArray

public FileHandle[] newHandleArray(int length)

Description copied from interface: BufferableContentHandle

Constructs an uninitialized array with the specified length with items of the same content representation.

Specified by:

newHandleArray in interface BufferableContentHandle<java.io.File,java.io.File>

Specified by:

newHandleArray in interface ResendableContentHandle<java.io.File,java.io.File>

Parameters:

length - the number of positions in the array

Returns:

the uninitialized array

newArray

public java.io.File[] newArray(int length)

Description copied from interface: ContentHandle

Constructs an array for the handled content representation

Specified by:

newArray in interface ContentHandle<java.io.File>

Parameters:

length - the size of the array (zero or more)

Returns:

the constructed array

withFormat

public FileHandle withFormat(Format format)

Specifies the format of the content and returns the handle as a fluent convenience.

Parameters:

format - the format of the content

Returns:

this handle

withMimetype

public FileHandle withMimetype(java.lang.String mimetype)

Specifies the mime type of the content and returns the handle as a fluent convenience.

Parameters:

mimetype - the mime type of the content

Returns:

this handle

toContent

public java.io.File toContent(java.io.File serialization)

Description copied from interface: BufferableContentHandle

Converts the serialization to the content representation.

Specified by:

toContent in interface BufferableContentHandle<java.io.File,java.io.File>

Parameters:

serialization - a serialization of the content

Returns:

the content representation

receiveAs

protected java.lang.Class<java.io.File> receiveAs()

Overrides:

receiveAs in class com.marklogic.client.impl.HandleImplementation<java.io.File,java.io.File>

receiveContent

protected void receiveContent(java.io.File content)

Overrides:

receiveContent in class com.marklogic.client.impl.HandleImplementation<java.io.File,java.io.File>

sendContent

protected java.io.File sendContent()

Overrides:

sendContent in class com.marklogic.client.impl.HandleImplementation<java.io.File,java.io.File>

fromBuffer

public void fromBuffer(byte[] buffer)

Description copied from interface: BufferableHandle

Sets the content of the handle by copying from a byte array buffer encoded in UTF-8.

Specified by:

fromBuffer in interface BufferableHandle

Parameters:

buffer - the byte array

toBuffer

public byte[] toBuffer()

Description copied from interface: BufferableHandle

Copies the content of the handle to a byte array buffer encoded in UTF-8.

Specified by:

toBuffer in interface BufferableHandle

Returns:

the byte array

bytesToContent

public java.io.File bytesToContent(byte[] buffer)

Description copied from interface: BufferableContentHandle

Converts a byte serialization to the content representation.

Specified by:

bytesToContent in interface BufferableContentHandle<java.io.File,java.io.File>

Parameters:

buffer - the byte serialization

Returns:

the content representation

contentToBytes

public byte[] contentToBytes(java.io.File content)

Description copied from interface: BufferableContentHandle

Converts the content representation to bytes.

Specified by:

contentToBytes in interface BufferableContentHandle<java.io.File,java.io.File>

Parameters:

content - the content

Returns:

the byte serialization of the content