Package net.webpdf.wsclient.openapi

Class OperationUrlConverterHeader

java.lang.Object

net.webpdf.wsclient.openapi.OperationUrlConverterHeader

public class OperationUrlConverterHeader
extends Object

Defines the content that will be used as a header. The content is passed in BASE64 encoded and contains HTML and (embedded) CSS code to position and format the header. The header can contain the variables `${html.pageNumber}` (page number), `${html.totalPages}` (total number of pages) and `${html.title}` (HTML head meta tag `<title>`). **Important:**The header is not used for all file format conversions. The header is not supported for file formats that already contain their own header definition, such as Office formats. The header defined here works only for HTML-based formats such as HTML files, emails, or template-based conversions (e.g. text formats). Example: ```html <p> <span style=\"font-size: 12px\">Page ${html.pageNumber} of ${html.totalPages} pages</span> </p> ```

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OperationUrlConverterHeader.SourceEnum	Selects the data source for the hereby expressed resource.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_SOURCE
static String	JSON_PROPERTY_URI
static String	JSON_PROPERTY_VALUE

Constructor Summary

Constructors

Constructor	Description
OperationUrlConverterHeader()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
@Nullable OperationUrlConverterHeader.SourceEnum	getSource()	Selects the data source for the hereby expressed resource.
@Nullable String	getUri()	The uri the data shall be located at.
@org.jetbrains.annotations.Nullable byte[]	getValue()	Get value
int	hashCode()
void	setSource(OperationUrlConverterHeader.SourceEnum source)
void	setUri(String uri)
void	setValue(byte[] value)
OperationUrlConverterHeader	source(OperationUrlConverterHeader.SourceEnum source)
String	toString()
OperationUrlConverterHeader	uri(String uri)
OperationUrlConverterHeader	value(byte[] value)

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROPERTY_SOURCE

public static final String JSON_PROPERTY_SOURCE

See Also:

Constant Field Values

JSON_PROPERTY_URI

public static final String JSON_PROPERTY_URI

See Also:

Constant Field Values

JSON_PROPERTY_VALUE

public static final String JSON_PROPERTY_VALUE

See Also:

Constant Field Values

Constructor Detail

OperationUrlConverterHeader

public OperationUrlConverterHeader()

Method Detail

source

public OperationUrlConverterHeader source(OperationUrlConverterHeader.SourceEnum source)

getSource

@Nullable
public @Nullable OperationUrlConverterHeader.SourceEnum getSource()

Selects the data source for the hereby expressed resource. Possible values are: * value = The element's value shall contain the BASE64 encoded data. * uri = The data shall be located at the given uri.

Returns:

source

setSource

public void setSource(OperationUrlConverterHeader.SourceEnum source)

uri

public OperationUrlConverterHeader uri(String uri)

getUri

@Nullable
public @Nullable String getUri()

The uri the data shall be located at. (This shall only have effect, if the \"source\" is \"uri\".)

Returns:

uri

setUri

public void setUri(String uri)

value

public OperationUrlConverterHeader value(byte[] value)

getValue

@Nullable
public @org.jetbrains.annotations.Nullable byte[] getValue()

Get value

Returns:

value

setValue

public void setValue(byte[] 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