ddf.catalog.data.impl

Class BinaryContentImpl

java.lang.Object

ddf.catalog.data.impl.BinaryContentImpl

All Implemented Interfaces:

BinaryContent

Direct Known Subclasses:

ResourceImpl, XsltTransformedContent

public class BinaryContentImpl
extends Object
implements BinaryContent

This class is a common implementation of the BinaryContent interface.

Constructor Summary

Constructors

Constructor and Description
BinaryContentImpl(InputStream inputStream) Instantiates a new product resource.
BinaryContentImpl(InputStream inputStream, MimeType mimeType) Instantiates a new product resource.

Method Summary

Modifier and Type	Method and Description
byte[]	getByteArray() Convenience method to attempt to read the contents of the InputStream into a byte array.
InputStream	getInputStream() Gets the input stream.
MimeType	getMimeType()
String	getMimeTypeValue() Gets the String format MimeType
long	getSize() Get the size if known.
void	setSize(long size) Sets the size in bytes of the binary content.
String	toString() String representation of this BinaryContentImpl.

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryContentImpl

public BinaryContentImpl(InputStream inputStream,
                         MimeType mimeType)

Instantiates a new product resource.

Parameters:

inputStream - the input stream

mimeType - the mime type for the resource

BinaryContentImpl

public BinaryContentImpl(InputStream inputStream)

Instantiates a new product resource.

Parameters:

inputStream - the input stream

Method Detail

getInputStream

public InputStream getInputStream()

Description copied from interface: BinaryContent

Gets the input stream.

Note that the binary from the InputStream can only be accessed once. Thus, when you call BinaryContent.getInputStream() and retrieve the InputStream object, it can only be used once to extract the content. If it is necessary that the bytes of the InputStream object are needed again, use the BinaryContent.getByteArray() method instead.

Specified by:

getInputStream in interface BinaryContent

Returns:

an input stream

getMimeType

public MimeType getMimeType()

Specified by:

getMimeType in interface BinaryContent

Returns:

the mime type of the information in the InputStream

getMimeTypeValue

public String getMimeTypeValue()

Description copied from interface: BinaryContent

Gets the String format MimeType

Specified by:

getMimeTypeValue in interface BinaryContent

Returns:

the mime type as a String

toString

public String toString()

String representation of this BinaryContentImpl.

Overrides:

toString in class Object

Returns:

the String representation of this BinaryContentImpl

getSize

public long getSize()

Description copied from interface: BinaryContent

Get the size if known.

Specified by:

getSize in interface BinaryContent

Returns:

the amount of bytes as a long, -1 if unknown

setSize

public void setSize(long size)

Sets the size in bytes of the binary content. If the size is unknown, then a -1 is returned.

Parameters:

size -

getByteArray

public byte[] getByteArray()
                    throws IOException

Description copied from interface: BinaryContent

Convenience method to attempt to read the contents of the InputStream into a byte array.

Note that BinaryContent.getByteArray() should be idempotent if BinaryContent.getInputStream() has not been initially invoked.

Specified by:

getByteArray in interface BinaryContent

Returns:

byte[]

Throws:

IOException - if the stream can not be read into the array