de.aristaflow.adept2.extensions.datatypes

Class FileUDT

java.lang.Object

de.aristaflow.adept2.extensions.datatypes.FileUDT

All Implemented Interfaces:

java.io.Serializable

public class FileUDT
extends java.lang.Object
implements java.io.Serializable

A simple object that wraps a file and provides access to all needed information to view a file in a form environment.

Author:

Marco Waimer

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FileUDT(byte[] data, java.lang.String filename, java.lang.String encoding, java.lang.String mimetype, long size) Default constructor that initialises the fields directly.
FileUDT(java.io.File file) Default constructor that initialises the fields from the given file.
FileUDT(java.io.File file, java.lang.String newFileName) Default constructor that initialises the fields from the given file, but using a different file name than actually provided by the file object.
FileUDT(java.io.InputStream xml)
FileUDT(UDTValue xml)

Method Summary

Modifier and Type	Method and Description
UDTValue	getAsXML()
byte[]	getData()
java.lang.String	getEncoding()
java.lang.String	getFileName()
java.lang.String	getMimeType()
long	getSize()
java.lang.String	getSizeString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FileUDT

public FileUDT(java.io.File file)

Default constructor that initialises the fields from the given file.

Parameters:

file - The file that should be wrapped by this class.

FileUDT

public FileUDT(java.io.File file,
               java.lang.String newFileName)

Default constructor that initialises the fields from the given file, but using a different file name than actually provided by the file object.

Parameters:

file - The file that should be wrapped by this class.

newFileName - The file name to be used in the file UDT.

FileUDT

public FileUDT(java.io.InputStream xml)

Parameters:

xml - The input stream containing the xml that contains the information for the file.

FileUDT

public FileUDT(UDTValue xml)

Parameters:

xml - The UDTValue representing the xml that contains the information for the file.

FileUDT

public FileUDT(byte[] data,
               java.lang.String filename,
               java.lang.String encoding,
               java.lang.String mimetype,
               long size)

Default constructor that initialises the fields directly.

Parameters:

data - The actual data of the file.

filename - The name of the file.

encoding - The encoding of the file, may be null.

mimetype - The mimetype of the file.

size - The size of the file.

Method Detail

getData

public byte[] getData()

Returns:

The actual raw data of the wrapped file.

getFileName

public java.lang.String getFileName()

Returns:

The name of the wrapped file.

getEncoding

public java.lang.String getEncoding()

Returns:

The encoding of the wrapped file.

getMimeType

public java.lang.String getMimeType()

Returns:

The mimetype of the wrapped file.

getSize

public long getSize()

Returns:

The size of the wrapped file.

getSizeString

public java.lang.String getSizeString()

Returns:

The size as formatted string.

getAsXML

public UDTValue getAsXML()

Returns:

The complete file information as XML packed in an UDTValue.