Package net.webpdf.wsclient.openapi

Class OperationFileAttachment

java.lang.Object

net.webpdf.wsclient.openapi.OperationFileAttachment

public class OperationFileAttachment
extends Object

Used to define an individual file attachment that should be added to the PDF document. This element can be used multiple times if you want to add multiple files.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_ANNOTATION
static String	JSON_PROPERTY_CREATOR
static String	JSON_PROPERTY_DATA
static String	JSON_PROPERTY_FILE_NAME
static String	JSON_PROPERTY_MIME_TYPE

Constructor Summary

Constructors

Constructor	Description
OperationFileAttachment()

Method Summary

Modifier and Type	Method	Description
OperationFileAttachment	annotation(OperationFileAnnotation annotation)
OperationFileAttachment	creator(String creator)
OperationFileAttachment	data(OperationAttachmentFileData data)
boolean	equals(Object o)
OperationFileAttachment	fileName(String fileName)
@Nullable OperationFileAnnotation	getAnnotation()	Get annotation
@Nullable String	getCreator()	Can be used to set an author for the attachment.
@NotNull OperationAttachmentFileData	getData()	Get data
@NotNull String	getFileName()	Used to define the name under which the attachment in the document will be created.
@Nullable String	getMimeType()	Can be used to set an optional MIME data type for the attachment.
int	hashCode()
OperationFileAttachment	mimeType(String mimeType)
void	setAnnotation(OperationFileAnnotation annotation)
void	setCreator(String creator)
void	setData(OperationAttachmentFileData data)
void	setFileName(String fileName)
void	setMimeType(String mimeType)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_ANNOTATION

public static final String JSON_PROPERTY_ANNOTATION

See Also:

Constant Field Values

JSON_PROPERTY_CREATOR

public static final String JSON_PROPERTY_CREATOR

See Also:

Constant Field Values

JSON_PROPERTY_DATA

public static final String JSON_PROPERTY_DATA

See Also:

Constant Field Values

JSON_PROPERTY_FILE_NAME

public static final String JSON_PROPERTY_FILE_NAME

See Also:

Constant Field Values

JSON_PROPERTY_MIME_TYPE

public static final String JSON_PROPERTY_MIME_TYPE

See Also:

Constant Field Values

Constructor Detail

OperationFileAttachment

public OperationFileAttachment()

Method Detail

annotation

public OperationFileAttachment annotation(OperationFileAnnotation annotation)

getAnnotation

@Nullable
public @Nullable OperationFileAnnotation getAnnotation()

Get annotation

Returns:

annotation

setAnnotation

public void setAnnotation(OperationFileAnnotation annotation)

creator

public OperationFileAttachment creator(String creator)

getCreator

@Nullable
public @Nullable String getCreator()

Can be used to set an author for the attachment. If you leave this value blank, the currently active system user will be used.

Returns:

creator

setCreator

public void setCreator(String creator)

data

public OperationFileAttachment data(OperationAttachmentFileData data)

getData

@NotNull
public @NotNull OperationAttachmentFileData getData()

Get data

Returns:

data

setData

public void setData(OperationAttachmentFileData data)

fileName

public OperationFileAttachment fileName(String fileName)

getFileName

@NotNull
public @NotNull String getFileName()

Used to define the name under which the attachment in the document will be created.

Returns:

fileName

setFileName

public void setFileName(String fileName)

mimeType

public OperationFileAttachment mimeType(String mimeType)

getMimeType

@Nullable
public @Nullable String getMimeType()

Can be used to set an optional MIME data type for the attachment. If you leave this value blank, the \"application/octet-stream\" MIME data type will be used.

Returns:

mimeType

setMimeType

public void setMimeType(String mimeType)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object