Package net.webpdf.wsclient.openapi
Class OperationAztecBarcode
- java.lang.Object
-
- net.webpdf.wsclient.openapi.OperationAztecBarcode
-
public class OperationAztecBarcode extends Object
A aztec barcode.
-
-
Field Summary
Fields Modifier and Type Field Description static StringJSON_PROPERTY_CHARSETstatic StringJSON_PROPERTY_ERROR_CORRECTIONstatic StringJSON_PROPERTY_LAYERSstatic StringJSON_PROPERTY_MARGINstatic StringJSON_PROPERTY_PAGESstatic StringJSON_PROPERTY_POSITIONstatic StringJSON_PROPERTY_ROTATIONstatic StringJSON_PROPERTY_VALUE
-
Constructor Summary
Constructors Constructor Description OperationAztecBarcode()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OperationAztecBarcodecharset(String charset)booleanequals(Object o)OperationAztecBarcodeerrorCorrection(Integer errorCorrection)@Nullable StringgetCharset()Used to specify the character set in which the barcode contents should be stored.@Nullable IntegergetErrorCorrection()Used to adjust the error correction level for generated Aztec Codes.@Nullable IntegergetLayers()Used to specify the number of layers that the generated Aztec Code should use.@Nullable IntegergetMargin()Used to specify the width of the empty frame that should be generated around the barcode.@Nullable StringgetPages()The page range for generating barcodes.@Nullable OperationRectanglegetPosition()Get position@Nullable IntegergetRotation()Used to specify the barcode's rotation in 90-degree increments.@NotNull StringgetValue()Contains the value that should be encoded in the barcode.inthashCode()OperationAztecBarcodelayers(Integer layers)OperationAztecBarcodemargin(Integer margin)OperationAztecBarcodepages(String pages)OperationAztecBarcodeposition(OperationRectangle position)OperationAztecBarcoderotation(Integer rotation)voidsetCharset(String charset)voidsetErrorCorrection(Integer errorCorrection)voidsetLayers(Integer layers)voidsetMargin(Integer margin)voidsetPages(String pages)voidsetPosition(OperationRectangle position)voidsetRotation(Integer rotation)voidsetValue(String value)StringtoString()OperationAztecBarcodevalue(String value)
-
-
-
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_LAYERS
public static final String JSON_PROPERTY_LAYERS
- 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
-
-
Method Detail
-
charset
public OperationAztecBarcode 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 OperationAztecBarcode errorCorrection(Integer errorCorrection)
-
getErrorCorrection
@Nullable public @Nullable Integer getErrorCorrection()
Used to adjust the error correction level for generated Aztec Codes. The higher the level, the more error-resistant the barcode, ensuring that damaged codes will still be readable. A percentage value of one to one hundred can be entered. minimum: 1 maximum: 100- Returns:
- errorCorrection
-
setErrorCorrection
public void setErrorCorrection(Integer errorCorrection)
-
layers
public OperationAztecBarcode layers(Integer layers)
-
getLayers
@Nullable public @Nullable Integer getLayers()
Used to specify the number of layers that the generated Aztec Code should use. The higher the number, the larger the resulting barcode and its capacity. * \"-4\" to \"-1\" = Compact Aztec Code with a minimum capacity of 13 digits or 12 letters and an area of 15 x 15 pixels. * \"0\" = Standard Aztec Code that will be optimized in order to use the smallest possible of layers for the value that is being encoded. * \"1\" to \"32\" = Standard Aztec Code with a maximum capacity of 3832 digits or 3067 letters and an area of 151 x 151 pixels. minimum: -4 maximum: 32- Returns:
- layers
-
setLayers
public void setLayers(Integer layers)
-
margin
public OperationAztecBarcode 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 OperationAztecBarcode 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 OperationAztecBarcode position(OperationRectangle position)
-
getPosition
@Nullable public @Nullable OperationRectangle getPosition()
Get position- Returns:
- position
-
setPosition
public void setPosition(OperationRectangle position)
-
rotation
public OperationAztecBarcode 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 OperationAztecBarcode 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)
-
-