FileBuffer

Method Summary
	cleanup() Releases resources. Best practice is to call this once you are done with this FileBuffer. Available in both 'read' and 'write' FileBuffer.
File	getFile(String filename) Returns the specified file. Available in a 'read' FileBuffer.
UnknownFile	getUnknownFile(String filename) Returns the specified file as unknown file. Available in a 'read' FileBuffer.
PacketDataList	listFiles() Returns a DataList of all the contents of this FileBuffer. Available in a 'read' FileBuffer.
	putFile(File file) Adds the file. Available in a 'write' FileBuffer.
	putFile(String folder, File file) Adds the file to the specified folder. Use forward slash '/' for multiple folders. Available in a 'write' FileBuffer.
	putFile(String folder, File file, String newFilename) Adds the file to the specified folder with a new filename. Use forward slash '/' for multiple folders. Available in a 'write' FileBuffer.
DocumentFile	toDocumentFile(String docfile) Creates a new DocumentFile from the contents of this FileBuffer. This can then be used for creating a Document. The docfile parameter must be the name of the XHTML document within the compressed file containing the content to be used for the document.
File	toFile(String filename) Does final compression and creates a new File from the contents of this FileBuffer. Available in a 'write' FileBuffer.
String	toString() Returns a description of this object.

Method Detail

cleanup()

Releases resources. Best practice is to call this once you are done with this FileBuffer. Available in both 'read' and 'write' FileBuffer.

Since: 08-27-2013

top

File getFile(String filename)

Returns the specified file. Available in a 'read' FileBuffer.

Parameters:

String filename Required parameter.

Returns: File

Since: 08-27-2013

top

UnknownFile getUnknownFile(String filename)

Returns the specified file as unknown file. Available in a 'read' FileBuffer.

Parameters:

String filename Required parameter.

Returns: UnknownFile

Since: 09-14-2018

top

PacketDataList listFiles()

Returns a DataList of all the contents of this FileBuffer. Available in a 'read' FileBuffer.

Returns: PacketDataList

DataList Name: files
DataList Fields: folder, file, fileSize, ext, modified

Since: 08-27-2013

top

putFile(File file)

Adds the file. Available in a 'write' FileBuffer.

Parameters:

File file Required parameter.

Since: 08-27-2013

top

putFile(String folder, File file)

Adds the file to the specified folder. Use forward slash '/' for multiple folders. Available in a 'write' FileBuffer.

Parameters:

String folder Required parameter.
File file Required parameter.

Since: 08-27-2013

top

putFile(String folder, File file, String newFilename)

Adds the file to the specified folder with a new filename. Use forward slash '/' for multiple folders. Available in a 'write' FileBuffer.

Parameters:

String folder Required parameter.
File file Required parameter.
String newFilename Required parameter.

Since: 04-16-2014

top

DocumentFile toDocumentFile(String docfile)

Creates a new DocumentFile from the contents of this FileBuffer. This can then be used for creating a Document. The docfile parameter must be the name of the XHTML document within the compressed file containing the content to be used for the document.

Parameters:

String docfile Required parameter.

Returns: DocumentFile

Since: 08-27-2013

top

File toFile(String filename)

Does final compression and creates a new File from the contents of this FileBuffer. Available in a 'write' FileBuffer.

Parameters:

String filename Required parameter.

Returns: File

Since: 08-27-2013

top

String toString()

Returns a description of this object.

Returns: String

Since: 08-27-2013

top

API Date: Nov 18, 2024 01:04 PM