Package org.faceless.publisher.type

Class Blob

java.lang.Object

org.faceless.publisher.type.Blob

All Implemented Interfaces:

AbstractBlob

public class Blob
extends Object
implements AbstractBlob

A general purpose blob of data which can be text or binary. To override, pass in a null byte[] and override getInputStream

Constructor Summary

Constructors

Constructor	Description
Blob(Blob blob, int r0, int r1, boolean line)
Blob(URL2 uri, MediaType type, byte[] buf, long lastModified)
Blob(URL2 uri, MediaType type, InputStream in, long lastModified)
Blob(URL2 uri, MediaType type, String data, long lastModified)
Blob(URL2 uri, MediaType type, ByteBuffer buf, long lastModified)

Method Summary

Modifier and Type	Method	Description
long	byteLength()	Return the byte-length of this attachment, or -1 if can't be determined yet
String	getAttachmentFileName()	Return the filename as set by setAttachmentFileName
byte[]	getBytes()	Return a copy of the byte data
long	getCreationDate()	Return the creation time as milliseconds since the UNIX Epoch if specified, or 0 otherwise.
EmbeddedFile	getEmbeddedFile(String name)	Return a new PDF EmbeddedFile based on the blob;
InputSource	getInputSource()	Return a new InputSource based on the character data if the charset is known, or the byte data otherwise.
InputStream	getInputStream()	Return a new InputStream for the byte data
long	getLastModified()	Return the last-modified time as milliseconds since the UNIX Epoch if specified, or 0 otherwise
MediaType	getMediaType()	Return the MediaType, which will be set to WILDCARD if it was given as null;
Reader	getReader()	Return a new Reader for the character data, which will be UTF-8 if the charset is not set in the MediaType
Source	getSource()	Return a new Source based on the character data if a charset is known, or the byte data otherwise.
String	getString()	Return the content of this Blob as a String, based on the byte data and the getEncoding()
URL2	getURL()	Return the URL as set in the constructor, which may be null
boolean	isCharsetSpecified()	Return true if a charset was specified.
void	setAttachmentFileName(String name)	Set the (optional) filename set from the Content-Disposition header
void	setCreationDate(long date)	Set the (optional) creation date.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.faceless.publisher.type.AbstractBlob

isTrusted

Constructor Details

Blob

public Blob(URL2 uri,
 MediaType type,
 String data,
 long lastModified)

Blob

public Blob(URL2 uri,
 MediaType type,
 ByteBuffer buf,
 long lastModified)

Blob

public Blob(URL2 uri,
 MediaType type,
 byte[] buf,
 long lastModified)

Blob

public Blob(URL2 uri,
 MediaType type,
 InputStream in,
 long lastModified)
     throws IOException

Throws:

IOException

Blob

public Blob(Blob blob,
 int r0,
 int r1,
 boolean line)
     throws IOException

Throws:

IOException

Method Details

setCreationDate

public void setCreationDate(long date)

Set the (optional) creation date.

Parameters:

date - the creation date in milliseconds since the UNIX epoch, or 0 to mark as unset (the default)

setAttachmentFileName

public void setAttachmentFileName(String name)

Set the (optional) filename set from the Content-Disposition header

getURL

public URL2 getURL()

Return the URL as set in the constructor, which may be null

Specified by:

getURL in interface AbstractBlob

getAttachmentFileName

public String getAttachmentFileName()

Return the filename as set by setAttachmentFileName

getMediaType

public MediaType getMediaType()

Return the MediaType, which will be set to WILDCARD if it was given as null;

Specified by:

getMediaType in interface AbstractBlob

getInputStream

public InputStream getInputStream()

Return a new InputStream for the byte data

Specified by:

getInputStream in interface AbstractBlob

getReader

public Reader getReader()

Return a new Reader for the character data, which will be UTF-8 if the charset is not set in the MediaType

getInputSource

public InputSource getInputSource()

Return a new InputSource based on the character data if the charset is known, or the byte data otherwise.

getSource

public Source getSource()

Return a new Source based on the character data if a charset is known, or the byte data otherwise.

getEmbeddedFile

public EmbeddedFile getEmbeddedFile(String name)

Return a new PDF EmbeddedFile based on the blob;

Parameters:

name - the name to use, will override the attachment name if specified

getBytes

public byte[] getBytes()

Return a copy of the byte data

isCharsetSpecified

public boolean isCharsetSpecified()

Return true if a charset was specified.

getString

public String getString()

Return the content of this Blob as a String, based on the byte data and the getEncoding()

getLastModified

public long getLastModified()

Return the last-modified time as milliseconds since the UNIX Epoch if specified, or 0 otherwise

Specified by:

getLastModified in interface AbstractBlob

getCreationDate

public long getCreationDate()

Return the creation time as milliseconds since the UNIX Epoch if specified, or 0 otherwise. This is set by setCreationDate(long)

Specified by:

getCreationDate in interface AbstractBlob

byteLength

public long byteLength()

Description copied from interface: AbstractBlob

Return the byte-length of this attachment, or -1 if can't be determined yet

Specified by:

byteLength in interface AbstractBlob

toString

public String toString()

Overrides:

toString in class Object