de.innovationgate.webgate.api

Class BinaryFieldData

java.lang.Object

de.innovationgate.webgate.api.BinaryFieldData

All Implemented Interfaces:

de.innovationgate.wga.common.ImmutableObject

public class BinaryFieldData
extends java.lang.Object
implements de.innovationgate.wga.common.ImmutableObject

Represents binary data on a field. Is returned by WGDocument.getExtensionData(String) when the data on the extension data field is binary.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BinaryFieldData.Retriever An interface for the functionality that actually retrieves the input stream of binary field data
class	BinaryFieldData.SizeReportingInputStream

Constructor Summary

Constructors

Constructor and Description
BinaryFieldData(long size, BinaryFieldData.Retriever retriever) Constructor for binary field datas from database.
BinaryFieldData(java.lang.Object binaryValue) Constructor to create an new binary field.

Method Summary

Methods

Modifier and Type	Method and Description
static java.io.InputStream	getBinaryDataInputStream(java.lang.Object value) Returns an input stream for all binary data object types that this object accepts as input
java.io.InputStream	getInputStream() Returns the binary data as input stream
long	getSize() Returns the size of the binary data in bytes.
static boolean	isBinaryValue(java.lang.Object value) Returns if a field value is "binary", i.e. can be used as input for this object

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryFieldData

public BinaryFieldData(long size,
               BinaryFieldData.Retriever retriever)

Constructor for binary field datas from database. Only for internal WGAPI use

Parameters:

size -

retriever -

BinaryFieldData

public BinaryFieldData(java.lang.Object binaryValue)
                throws java.io.IOException

Constructor to create an new binary field.

Parameters:

binaryValue - The binary value. Either an InputStream, byte array, File, DataSource or another BinaryFieldData object

Throws:

java.io.IOException

Method Detail

isBinaryValue

public static boolean isBinaryValue(java.lang.Object value)

Returns if a field value is "binary", i.e. can be used as input for this object

getSize

public long getSize()

Returns the size of the binary data in bytes. May be -1 when not yet saved.

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Returns the binary data as input stream

Throws:

java.io.IOException

getBinaryDataInputStream

public static java.io.InputStream getBinaryDataInputStream(java.lang.Object value)
                                                    throws java.io.IOException

Returns an input stream for all binary data object types that this object accepts as input

Parameters:

value - The binary value. Accepts the same types as BinaryFieldData(Object) constructor.

Throws:

java.io.IOException