Package net.webpdf.wsclient.openapi

Class OperationQrBarcode

java.lang.Object

net.webpdf.wsclient.openapi.OperationQrBarcode

public class OperationQrBarcode
extends Object

A QR barcode.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OperationQrBarcode.ErrorCorrectionEnum	Used to adjust the error correction level for generated QR codes.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_CHARSET
static String	JSON_PROPERTY_ERROR_CORRECTION
static String	JSON_PROPERTY_MARGIN
static String	JSON_PROPERTY_PAGES
static String	JSON_PROPERTY_POSITION
static String	JSON_PROPERTY_ROTATION
static String	JSON_PROPERTY_VALUE

Constructor Summary

Constructors

Constructor	Description
OperationQrBarcode()

Method Summary

Modifier and Type	Method	Description
OperationQrBarcode	charset(String charset)
boolean	equals(Object o)
OperationQrBarcode	errorCorrection(OperationQrBarcode.ErrorCorrectionEnum errorCorrection)
@Nullable String	getCharset()	Used to specify the character set in which the barcode contents should be stored.
@Nullable OperationQrBarcode.ErrorCorrectionEnum	getErrorCorrection()	Used to adjust the error correction level for generated QR codes.
@Nullable Integer	getMargin()	Used to specify the width of the empty frame that should be generated around the barcode.
@Nullable String	getPages()	The page range for generating barcodes.
@Nullable OperationRectangle	getPosition()	Get position
@Nullable Integer	getRotation()	Used to specify the barcode's rotation in 90-degree increments.
@NotNull String	getValue()	Contains the value that should be encoded in the barcode.
int	hashCode()
OperationQrBarcode	margin(Integer margin)
OperationQrBarcode	pages(String pages)
OperationQrBarcode	position(OperationRectangle position)
OperationQrBarcode	rotation(Integer rotation)
void	setCharset(String charset)
void	setErrorCorrection(OperationQrBarcode.ErrorCorrectionEnum errorCorrection)
void	setMargin(Integer margin)
void	setPages(String pages)
void	setPosition(OperationRectangle position)
void	setRotation(Integer rotation)
void	setValue(String value)
String	toString()
OperationQrBarcode	value(String value)

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROPERTY_CHARSET

public static final String JSON_PROPERTY_CHARSET

See Also:

Constant Field Values

JSON_PROPERTY_ERROR_CORRECTION

public static final String JSON_PROPERTY_ERROR_CORRECTION

See Also:

Constant Field Values

JSON_PROPERTY_MARGIN

public static final String JSON_PROPERTY_MARGIN

See Also:

Constant Field Values

JSON_PROPERTY_PAGES

public static final String JSON_PROPERTY_PAGES

See Also:

Constant Field Values

JSON_PROPERTY_POSITION

public static final String JSON_PROPERTY_POSITION

See Also:

Constant Field Values

JSON_PROPERTY_ROTATION

public static final String JSON_PROPERTY_ROTATION

See Also:

Constant Field Values

JSON_PROPERTY_VALUE

public static final String JSON_PROPERTY_VALUE

See Also:

Constant Field Values

Constructor Detail

OperationQrBarcode

public OperationQrBarcode()

Method Detail

charset

public OperationQrBarcode charset(String charset)

getCharset

@Nullable
public @Nullable String getCharset()

Used to specify the character set in which the barcode contents should be stored.

Returns:

charset

setCharset

public void setCharset(String charset)

errorCorrection

public OperationQrBarcode errorCorrection(OperationQrBarcode.ErrorCorrectionEnum errorCorrection)

getErrorCorrection

@Nullable
public @Nullable OperationQrBarcode.ErrorCorrectionEnum getErrorCorrection()

Used to adjust the error correction level for generated QR codes. The higher the level, the more error-resistant the barcode, ensuring that damaged codes will still be readable. * l = Low * m = Medium * q = Quartile * h = High

Returns:

errorCorrection

setErrorCorrection

public void setErrorCorrection(OperationQrBarcode.ErrorCorrectionEnum errorCorrection)

margin

public OperationQrBarcode margin(Integer margin)

getMargin

@Nullable
public @Nullable Integer getMargin()

Used to specify the width of the empty frame that should be generated around the barcode. This shall use the same metrics as the position - if no position is present, the default (mm) shall be assumed. minimum: 0

Returns:

margin

setMargin

public void setMargin(Integer margin)

pages

public OperationQrBarcode pages(String pages)

getPages

@Nullable
public @Nullable String getPages()

The page range for generating barcodes. Individual pages or a range of pages can be defined here. If the text is empty, the entire file will be exported (e.g.: \"1-10\" or \"1,2,5-10\")

Returns:

pages

setPages

public void setPages(String pages)

position

public OperationQrBarcode position(OperationRectangle position)

getPosition

@Nullable
public @Nullable OperationRectangle getPosition()

Get position

Returns:

position

setPosition

public void setPosition(OperationRectangle position)

rotation

public OperationQrBarcode rotation(Integer rotation)

getRotation

@Nullable
public @Nullable Integer getRotation()

Used to specify the barcode's rotation in 90-degree increments. When there is a value that falls under a full 90-degree increment, the next higher increment will be automatically selected. minimum: 0

Returns:

rotation

setRotation

public void setRotation(Integer rotation)

value

public OperationQrBarcode value(String value)

getValue

@NotNull
public @NotNull String getValue()

Contains the value that should be encoded in the barcode. Depending on the selected barcode format, there may be specific criteria for the data structure. For a description, please refer to the chapter \"Barcodes\"

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