Package net.webpdf.wsclient.openapi

Class OperationDescriptionCustom

java.lang.Object

net.webpdf.wsclient.openapi.OperationDescriptionCustom

public class OperationDescriptionCustom
extends Object

If you add another (optional) `<custom .../>` element to the description element, you can use it to store your own values in the PDF description. The element can occur multiple times and defines an additional entry for the description.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_KEY
static String	JSON_PROPERTY_REMOVE
static String	JSON_PROPERTY_VALUE

Constructor Summary

Constructors

Constructor	Description
OperationDescriptionCustom()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@Nullable String	getKey()	Describes the name of the field to be added to the PDF description.
@Nullable Boolean	getRemove()	If \"true\", then the field is not added but removed.
@Nullable String	getValue()	Describes the value to be stored in the PDF description.
int	hashCode()
OperationDescriptionCustom	key(String key)
OperationDescriptionCustom	remove(Boolean remove)
void	setKey(String key)
void	setRemove(Boolean remove)
void	setValue(String value)
String	toString()
OperationDescriptionCustom	value(String value)

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROPERTY_KEY

public static final String JSON_PROPERTY_KEY

See Also:

Constant Field Values

JSON_PROPERTY_REMOVE

public static final String JSON_PROPERTY_REMOVE

See Also:

Constant Field Values

JSON_PROPERTY_VALUE

public static final String JSON_PROPERTY_VALUE

See Also:

Constant Field Values

Constructor Detail

OperationDescriptionCustom

public OperationDescriptionCustom()

Method Detail

key

public OperationDescriptionCustom key(String key)

getKey

@Nullable
public @Nullable String getKey()

Describes the name of the field to be added to the PDF description. The value must not be empty, must be unique, and must not conflict with the other (default) field names (e.g. \"Subject\"). If a name conflict occurs, the entry will be skipped and not entered.

Returns:

key

setKey

public void setKey(String key)

remove

public OperationDescriptionCustom remove(Boolean remove)

getRemove

@Nullable
public @Nullable Boolean getRemove()

If \"true\", then the field is not added but removed. In this case \"value\" has no meaning. If the field is not present, then the entry is skipped.

Returns:

remove

setRemove

public void setRemove(Boolean remove)

value

public OperationDescriptionCustom value(String value)

getValue

@Nullable
public @Nullable String getValue()

Describes the value to be stored in the PDF description.

Returns:

value

setValue

public void setValue(String value)

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