java.lang.Object
- net.webpdf.wsclient.openapi.OperationDataMatrixBarcode

public class OperationDataMatrixBarcode
extends Object

A DataMatrix barcode.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class OperationDataMatrixBarcode.ShapeEnum
Can be used to force a specific shape for generated Data Matrix 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_SHAPE`
`static String`	`JSON_PROPERTY_VALUE`

Constructor Summary

Constructors
Constructor Description

OperationDataMatrixBarcode()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`OperationDataMatrixBarcode`	`charset(String charset)`
`boolean`	`equals(Object o)`
`OperationDataMatrixBarcode`	`errorCorrection(Integer errorCorrection)`
`@Nullable String`	`getCharset()`	Used to specify the character set in which the barcode contents should be stored.
`@Nullable Integer`	`getErrorCorrection()`	Used to adjust the error correction level for generated Data Matrix 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.
`@Nullable OperationDataMatrixBarcode.ShapeEnum`	`getShape()`	Can be used to force a specific shape for generated Data Matrix codes
`@NotNull String`	`getValue()`	Contains the value that should be encoded in the barcode.
`int`	`hashCode()`
`OperationDataMatrixBarcode`	`margin(Integer margin)`
`OperationDataMatrixBarcode`	`pages(String pages)`
`OperationDataMatrixBarcode`	`position(OperationRectangle position)`
`OperationDataMatrixBarcode`	`rotation(Integer rotation)`
`void`	`setCharset(String charset)`
`void`	`setErrorCorrection(Integer errorCorrection)`
`void`	`setMargin(Integer margin)`
`void`	`setPages(String pages)`
`void`	`setPosition(OperationRectangle position)`
`void`	`setRotation(Integer rotation)`
`void`	`setShape(OperationDataMatrixBarcode.ShapeEnum shape)`
`void`	`setValue(String value)`
`OperationDataMatrixBarcode`	`shape(OperationDataMatrixBarcode.ShapeEnum shape)`
`String`	`toString()`
`OperationDataMatrixBarcode`	`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_SHAPE
```
public static final String JSON_PROPERTY_SHAPE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_VALUE
```
public static final String JSON_PROPERTY_VALUE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - OperationDataMatrixBarcode
```
public OperationDataMatrixBarcode()
```
- Method Detail
  - charset
```
public OperationDataMatrixBarcode 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 OperationDataMatrixBarcode errorCorrection(Integer errorCorrection)
```
  - getErrorCorrection
```
@Nullable
public @Nullable Integer getErrorCorrection()
```
    Used to adjust the error correction level for generated Data Matrix codes. The higher the level, the more error-resistant the barcode, ensuring that damaged codes will still be readable. A level of 1 to 8 can be specified. minimum: 1 maximum: 8
    
    Returns:
    
    errorCorrection
  - setErrorCorrection
```
public void setErrorCorrection(Integer errorCorrection)
```
  - margin
```
public OperationDataMatrixBarcode 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 OperationDataMatrixBarcode 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 OperationDataMatrixBarcode position(OperationRectangle position)
```
  - getPosition
```
@Nullable
public @Nullable OperationRectangle getPosition()
```
    Get position
    
    Returns:
    
    position
  - setPosition
```
public void setPosition(OperationRectangle position)
```
  - rotation
```
public OperationDataMatrixBarcode 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)
```
  - shape
```
public OperationDataMatrixBarcode shape(OperationDataMatrixBarcode.ShapeEnum shape)
```
  - getShape
```
@Nullable
public @Nullable OperationDataMatrixBarcode.ShapeEnum getShape()
```
    Can be used to force a specific shape for generated Data Matrix codes. * default = Select an appropriate shape. * rectangle = Force a rectangular shape. * square = Force a square shape.
    
    Returns:
    
    shape
  - setShape
```
public void setShape(OperationDataMatrixBarcode.ShapeEnum shape)
```
  - value
```
public OperationDataMatrixBarcode 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

Class OperationDataMatrixBarcode

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_CHARSET

JSON_PROPERTY_ERROR_CORRECTION

JSON_PROPERTY_MARGIN

JSON_PROPERTY_PAGES

JSON_PROPERTY_POSITION

JSON_PROPERTY_ROTATION

JSON_PROPERTY_SHAPE

JSON_PROPERTY_VALUE

Constructor Detail

OperationDataMatrixBarcode

Method Detail

charset

getCharset

setCharset

errorCorrection

getErrorCorrection

setErrorCorrection

margin

getMargin

setMargin

pages

getPages

setPages

position

getPosition

setPosition

rotation

getRotation

setRotation

shape

getShape

setShape

value

getValue

setValue

equals

hashCode

toString