Package com.realobjects.pdfreactor

Class Configuration.Attachment

java.lang.Object

com.realobjects.pdfreactor.Configuration.Attachment

Enclosing class:

Configuration

public static final class Configuration.Attachment
extends Object

A type containing attachment data.

Constructor Summary

Constructors

Constructor	Description
Attachment()

Method Summary

Modifier and Type	Method	Description
Configuration.Attachment	setData(byte[] value)	The binary content of the attachment.
Configuration.Attachment	setDescription(String value)	The description of the attachment.
Configuration.Attachment	setMimeType(String value)	The MIME type of the attachment.
Configuration.Attachment	setName(String value)	The file name associated with the attachment.
Configuration.Attachment	setUrl(String value)	If setData(byte[]) is not set or set to null, the attachment will be retrieved from this URL.

Methods inherited from class java.lang.Object

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

Constructor Details

Attachment

public Attachment()

Method Details

setData

public Configuration.Attachment setData(byte[] value)

The binary content of the attachment. May be null.

Returns:

The current Configuration.Attachment instance.

setUrl

public Configuration.Attachment setUrl(String value)

If setData(byte[]) is not set or set to null, the attachment will be retrieved from this URL.

If this is "#" the input document URL is used instead.

Returns:

The current Configuration.Attachment instance.

setName

public Configuration.Attachment setName(String value)

The file name associated with the attachment. It is recommended to specify the correct file extension. If this is not set or null the name is derived from setUrl(String).

Returns:

The current Configuration.Attachment instance.

setDescription

public Configuration.Attachment setDescription(String value)

The description of the attachment. If this is not set or null the value of setName(String) is used.

Returns:

The current Configuration.Attachment instance.

setMimeType

public Configuration.Attachment setMimeType(String value)

The MIME type of the attachment. If this is not set, null or the empty string, detection is attempted or the default value application/octet-stream is used.
Please note that viewers generally ignore the MIME type in favor of the file extension. However, automatic processing of PDF documents may require attachments to have specific MIME types.

Returns:

The current Configuration.Attachment instance.