com.realobjects.pdfreactor

Class Configuration.Attachment

java.lang.Object

com.realobjects.pdfreactor.Configuration.Attachment

Enclosing class:

Configuration

public static class Configuration.Attachment
extends Object

A type containing attachment data.

Constructor Summary

Constructors

Constructor and Description
Attachment()
Attachment(byte[] data, String url, String name, String description) Deprecated.

Method Summary

Modifier and Type	Method and Description
Configuration.Attachment	setData(byte[] value) The binary content of the attachment.
Configuration.Attachment	setDescription(String value) The description of the attachment.
Configuration.Attachment	setName(String value) The file name associated with the attachment.
Configuration.Attachment	setUrl(String value) If Configuration.Attachment.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 Detail

Attachment

public Attachment()

Attachment

@Deprecated
public Attachment(byte[] data,
                              String url,
                              String name,
                              String description)

Deprecated.

Method Detail

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 Configuration.Attachment.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 Configuration.Attachment.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 Configuration.Attachment.setName(String) is used.

Returns:

The current Configuration.Attachment instance.