com.marklogic.client.io

Class FileHandle

java.lang.Object

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

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

com.marklogic.client.io.FileHandle

All Implemented Interfaces:

ContentDescriptor, AbstractReadHandle, AbstractWriteHandle, BinaryReadHandle, BinaryWriteHandle, ContentHandle<File>, DocumentMetadataReadHandle, DocumentMetadataWriteHandle, DocumentPatchHandle, GenericReadHandle, GenericWriteHandle, JSONReadHandle, JSONWriteHandle, QueryOptionsListReadHandle, QueryOptionsReadHandle, QueryOptionsWriteHandle, RuleListReadHandle, RuleReadHandle, RuleWriteHandle, SearchReadHandle, StructureReadHandle, StructureWriteHandle, TextReadHandle, TextWriteHandle, TuplesReadHandle, ValuesListReadHandle, ValuesReadHandle, XMLReadHandle, XMLWriteHandle

public class FileHandle
extends BaseHandle<File,File>
implements ContentHandle<File>, BinaryReadHandle, BinaryWriteHandle, GenericReadHandle, GenericWriteHandle, JSONReadHandle, JSONWriteHandle, TextReadHandle, TextWriteHandle, XMLReadHandle, XMLWriteHandle, StructureReadHandle, StructureWriteHandle

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(File content) Initializes the handle with a file containing the content.

Method Summary

Methods

Modifier and Type	Method and Description
File	get() Returns the file for the handle content.
static ContentHandleFactory	newFactory() Creates a factory to create a FileHandle for a file.
void	set(File content) Assigns a file as the content.
FileHandle	with(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(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, setByteLength, setFormat, setMimetype

Methods inherited from class java.lang.Object

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

Constructor Detail

FileHandle

public FileHandle()

Zero-argument constructor.

FileHandle

public FileHandle(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 File get()

Returns the file for the handle content.

Specified by:

get in interface ContentHandle<File>

Returns:

the file

set

public void set(File content)

Assigns a file as the content.

Specified by:

set in interface ContentHandle<File>

Parameters:

content - the file

with

public FileHandle with(File content)

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

Parameters:

content - the file

Returns:

this handle

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(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