Skip to content

Commit e1efb62

Browse files
committed
Javadoc API for Aspose.Barcode for Java release 25.2 is added
1 parent 07fa517 commit e1efb62

File tree

13 files changed

+127
-140
lines changed

13 files changed

+127
-140
lines changed

english/java/com.aspose.barcode.barcoderecognition/barcodereader/_index.md

Lines changed: 35 additions & 35 deletions
Large diffs are not rendered by default.

english/java/com.aspose.barcode.barcoderecognition/barcoderesult/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ Stores recognized barcode data like SingleDecodeType type, string codetext,
1919
> ```
2020
> This sample shows how to obtain BarCodeResult.
2121
>
22-
> BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.Code128, "12345");
22+
> BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.CODE_128, "12345");
2323
> generator.save("c:\\test.png");
24-
> BarCodeReader reader = new BarCodeReader("c:\\test.png", DecodeType.CODE_39_STANDARD, DecodeType.CODE_128);
24+
> BarCodeReader reader = new BarCodeReader("c:\\test.png", DecodeType.CODE_39, DecodeType.CODE_128);
2525
> for(BarCodeResult result : reader.readBarCodes())
2626
> {
2727
> System.out.println("BarCode Type: " + result.getCodeTypeName());

english/java/com.aspose.barcode.barcoderecognition/basedecodetype/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Base class for MultyDecodeType and SingleDecodeType.
2020
> This sample shows how to use BaseDecodeType with SingleDecodeType and MultyDecodeType
2121
>
2222
> BaseDecodeType decodeOne = DecodeType.CODE_128;
23-
> BaseDecodeType decodeTwo = new MultyDecodeType(DecodeType.CODE_128, DecodeType.CODE_39_STANDARD, DecodeType.CODE_39_EXTENDED);
23+
> BaseDecodeType decodeTwo = new MultyDecodeType(DecodeType.CODE_128, DecodeType.CODE_39_STANDARD, DecodeType.CODE_39_FULL_ASCII);
2424
> ```
2525
## Methods
2626

english/java/com.aspose.barcode.barcoderecognition/decodetype/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Specify the type of barcode to read.
1919
> ```
2020
> This sample shows how to detect Code39 and Code128 barcodes.
2121
>
22-
> BarCodeReader reader = new BarCodeReader("c:\\test.png", DecodeType.CODE_39_STANDARD, DecodeType.CODE_128);
22+
> BarCodeReader reader = new BarCodeReader("c:\\test.png", DecodeType.CODE_39_FULL_ASCII, DecodeType.CODE_128);
2323
> for(BarCodeResult result : reader.readBarCodes())
2424
> {
2525
> System.out.println("BarCode Type: " + result.getCodeTypeName());

english/java/com.aspose.barcode.barcoderecognition/maxicodeextendedparameters/_index.md

Lines changed: 0 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,6 @@ Stores a MaxiCode additional information of recognized barcode
2727
| [isEmpty()](#isEmpty--) | Tests whether all parameters has only default values |
2828
| [notify()](#notify--) | |
2929
| [notifyAll()](#notifyAll--) | |
30-
| [setMaxiCodeMode(int maxiCodeMode)](#setMaxiCodeMode-int-) | Sets a MaxiCode encode mode. |
31-
| [setMaxiCodeStructuredAppendModeBarcodeId(int value)](#setMaxiCodeStructuredAppendModeBarcodeId-int-) | Sets a MaxiCode barcode id in structured append mode. |
32-
| [setMaxiCodeStructuredAppendModeBarcodesCount(int value)](#setMaxiCodeStructuredAppendModeBarcodesCount-int-) | Sets a MaxiCode barcodes count in structured append mode. |
3330
| [toString()](#toString--) | Returns a human-readable string representation of this MaxiCodeExtendedParameters . |
3431
| [wait()](#wait--) | |
3532
| [wait(long arg0)](#wait-long-) | |
@@ -137,45 +134,6 @@ public final native void notifyAll()
137134

138135

139136

140-
### setMaxiCodeMode(int maxiCodeMode) {#setMaxiCodeMode-int-}
141-
```
142-
public void setMaxiCodeMode(int maxiCodeMode)
143-
```
144-
145-
146-
Sets a MaxiCode encode mode. Default value: Mode4
147-
148-
**Parameters:**
149-
| Parameter | Type | Description |
150-
| --- | --- | --- |
151-
| maxiCodeMode | int | |
152-
153-
### setMaxiCodeStructuredAppendModeBarcodeId(int value) {#setMaxiCodeStructuredAppendModeBarcodeId-int-}
154-
```
155-
public void setMaxiCodeStructuredAppendModeBarcodeId(int value)
156-
```
157-
158-
159-
Sets a MaxiCode barcode id in structured append mode. Default value: 0
160-
161-
**Parameters:**
162-
| Parameter | Type | Description |
163-
| --- | --- | --- |
164-
| value | int | |
165-
166-
### setMaxiCodeStructuredAppendModeBarcodesCount(int value) {#setMaxiCodeStructuredAppendModeBarcodesCount-int-}
167-
```
168-
public void setMaxiCodeStructuredAppendModeBarcodesCount(int value)
169-
```
170-
171-
172-
Sets a MaxiCode barcodes count in structured append mode. Default value: -1
173-
174-
**Parameters:**
175-
| Parameter | Type | Description |
176-
| --- | --- | --- |
177-
| value | int | |
178-
179137
### toString() {#toString--}
180138
```
181139
public String toString()

english/java/com.aspose.barcode.barcoderecognition/multydecodetype/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Composite decode type.
2020
> CreateThis sample shows how to create compound MultyDecode types that combine SingleDecodeType and MultiDecode types.
2121
>
2222
> MultyDecodeType types1 = new MultyDecodeType(DecodeType.QR, DecodeType.DATA_MATRIX);
23-
> MultyDecodeType types2 = new MultyDecodeType(types1, DecodeType.CODE_128, DecodeType.CODE_39_STANDARD);
23+
> MultyDecodeType types2 = new MultyDecodeType(types1, DecodeType.CODE_128, DecodeType.CODE_39);
2424
> ```
2525
## Constructors
2626

english/java/com.aspose.barcode.complexbarcode/hibcliccombinedcodetext/_index.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -34,23 +34,19 @@ Class for encoding and decoding the text embedded in the HIBC LIC code which sto
3434
> combinedCodetext.getSecondaryAndAdditionalData().setSerialNumber("SERIAL123");
3535
> combinedCodetext.getSecondaryAndAdditionalData().setDateOfManufacture(new Date());
3636
> ComplexBarcodeGenerator generator = new ComplexBarcodeGenerator(combinedCodetext);
37-
> {
38-
> BufferedImage image = generator.generateBarCodeImage();
39-
> BarCodeReader reader = new BarCodeReader(image, DecodeType.HIBCQRLIC);
40-
> {
41-
> reader.readBarCodes();
42-
> String codetext = reader.getFoundBarCodes()[0].getCodeText();
43-
> HIBCLICCombinedCodetext result = (HIBCLICCombinedCodetext)ComplexCodetextReader.tryDecodeHIBCLIC(codetext);
44-
> System.out.println("Product or catalog number: " + result.getPrimaryData().getProductOrCatalogNumber());
45-
> System.out.println("Labeler identification code: " + result.getPrimaryData().getLabelerIdentificationCode());
46-
> System.out.println("Unit of measure ID: " + result.getPrimaryData().getUnitOfMeasureID());
47-
> System.out.println("Expiry date: " + result.getSecondaryAndAdditionalData().getExpiryDate());
48-
> System.out.println("Quantity: " + result.getSecondaryAndAdditionalData().getQuantity());
49-
> System.out.println("Lot number: " + result.getSecondaryAndAdditionalData().getLotNumber());
50-
> System.out.println("Serial number: " + result.getSecondaryAndAdditionalData().getSerialNumber());
51-
> System.out.println("Date of manufacture: " + result.getSecondaryAndAdditionalData().getDateOfManufacture());
52-
> }
53-
> }
37+
> BufferedImage image = generator.generateBarCodeImage();
38+
> BarCodeReader reader = new BarCodeReader(image, DecodeType.HIBCQRLIC);
39+
> reader.readBarCodes();
40+
> String codetext = reader.getFoundBarCodes()[0].getCodeText();
41+
> HIBCLICCombinedCodetext result = (HIBCLICCombinedCodetext)ComplexCodetextReader.tryDecodeHIBCLIC(codetext);
42+
> System.out.println("Product or catalog number: " + result.getPrimaryData().getProductOrCatalogNumber());
43+
> System.out.println("Labeler identification code: " + result.getPrimaryData().getLabelerIdentificationCode());
44+
> System.out.println("Unit of measure ID: " + result.getPrimaryData().getUnitOfMeasureID());
45+
> System.out.println("Expiry date: " + result.getSecondaryAndAdditionalData().getExpiryDate());
46+
> System.out.println("Quantity: " + result.getSecondaryAndAdditionalData().getQuantity());
47+
> System.out.println("Lot number: " + result.getSecondaryAndAdditionalData().getLotNumber());
48+
> System.out.println("Serial number: " + result.getSecondaryAndAdditionalData().getSerialNumber());
49+
> System.out.println("Date of manufacture: " + result.getSecondaryAndAdditionalData().getDateOfManufacture());
5450
> ```
5551
## Constructors
5652

english/java/com.aspose.barcode.complexbarcode/hibclicprimarydatacodetext/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Class for encoding and decoding the text embedded in the HIBC LIC code which sto
1919
> ```
2020
> This sample shows how to encode and decode HIBC LIC using HIBCLICPrimaryDataCodetext.
2121
>
22-
> HIBCLICPrimaryCodetext complexCodetext = new HIBCLICPrimaryDataCodetext();
22+
> HIBCLICPrimaryDataCodetext complexCodetext = new HIBCLICPrimaryDataCodetext();
2323
> complexCodetext.setBarcodeType(EncodeTypes.HIBCQRLIC);
2424
> complexCodetext.setData(new PrimaryData());
2525
> complexCodetext.getData().setProductOrCatalogNumber("12345");
@@ -31,7 +31,7 @@ Class for encoding and decoding the text embedded in the HIBC LIC code which sto
3131
> BarCodeReader reader = new BarCodeReader(image, DecodeType.HIBCQRLIC);
3232
> {
3333
> reader.readBarCodes();
34-
> String codetext = reader.getFoundBarCodes()[0].getCodeText();
34+
> HIBCLICPrimaryCodetext result = (HIBCLICPrimaryCodetext)ComplexCodetextReader.TryDecodeHIBCLIC(codetext);
3535
> HIBCLICPrimaryCodetext result = (HIBCLICPrimaryCodetext)ComplexCodetextReader.tryDecodeHIBCLIC(codetext);
3636
> System.out.println("Product or catalog number: " + result.getData().getProductOrCatalogNumber());
3737
> System.out.println("Labeler identification code: " + result.getData().getLabelerIdentificationCode());

english/java/com.aspose.barcode.generation/autosizemode/_index.md

Lines changed: 6 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,13 @@ java.lang.Object, java.lang.Enum
1212
public enum AutoSizeMode extends Enum<AutoSizeMode>
1313
```
1414

15-
Specifies the different types of automatic sizing modes. Default value is AutoSizeMode.NONE.
16-
17-
--------------------
18-
19-
> ```
20-
> This sample shows how to create and save a BarCode image.
21-
>
22-
> BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.DATA_MATRIX);
23-
> generator.getParameters().setAutoSizeMode(AutoSizeMode.NEAREST);
24-
> generator.getParameters().getBarCodeWidth().setMillimeters(50);
25-
> generator.getParameters().getBarCodeHeight().setInches(1.3f);
26-
> generator.save("test.png");
27-
> ```
15+
Specifies the different types of automatic sizing modes.
2816
## Fields
2917

3018
| Field | Description |
3119
| --- | --- |
32-
| [INTERPOLATION](#INTERPOLATION) | Resizes barcode to specified size with little scaling but it can be little damaged in some cases because using interpolation for scaling. |
33-
| [NEAREST](#NEAREST) | Barcode resizes to nearest lowest possible size which are specified by BarCodeWidth and BarCodeHeight properties. |
20+
| [INTERPOLATION](#INTERPOLATION) | Resizes barcode to specified size. |
21+
| [NEAREST](#NEAREST) | Resizes barcode to nearest lowest possible size specified by ImageWidth and ImageHeight properties. |
3422
| [NONE](#NONE) | Automatic resizing is disabled. |
3523
## Methods
3624

@@ -59,35 +47,23 @@ public static final AutoSizeMode INTERPOLATION
5947
```
6048

6149

62-
Resizes barcode to specified size with little scaling but it can be little damaged in some cases because using interpolation for scaling. Size can be specified by BarcodeGenerator.BarCodeWidth and BarcodeGenerator.BarCodeHeight properties.
63-
64-
--------------------
65-
66-
> ```
67-
> This sample shows how to create and save a BarCode image in Scale mode.
68-
>
69-
> BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.DATA_MATRIX);
70-
> generator.getParameters().setAutoSizeMode(AutoSizeMode.INTERPOLATION);
71-
> generator.getParameters().getBarCodeWidth().setMillimeters(50);
72-
> generator.getParameters().getBarCodeHeight().setInches(1.3f);
73-
> generator.save("test.png");
74-
> ```
50+
Resizes barcode to specified size. Size can be specified by ImageWidth and ImageHeight properties. Generated barcode may be invalid (not readable) after scaling.
7551

7652
### NEAREST {#NEAREST}
7753
```
7854
public static final AutoSizeMode NEAREST
7955
```
8056

8157

82-
Barcode resizes to nearest lowest possible size which are specified by BarCodeWidth and BarCodeHeight properties.
58+
Resizes barcode to nearest lowest possible size specified by ImageWidth and ImageHeight properties. Preserves default aspect ratio.
8359

8460
### NONE {#NONE}
8561
```
8662
public static final AutoSizeMode NONE
8763
```
8864

8965

90-
Automatic resizing is disabled. Default value.
66+
Automatic resizing is disabled.
9167

9268
### <T>valueOf(Class<T> arg0, String arg1) {#-T-valueOf-java.lang.Class-T--java.lang.String-}
9369
```

english/java/com.aspose.barcode.generation/barcodegenerator/_index.md

Lines changed: 51 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ public final class BarcodeGenerator
1414

1515
BarcodeGenerator for backend barcode images generation.
1616

17-
supported symbologies: 1D: Codabar, Code11, Code128, Code39Standard, Code39Extended Code93Standard, Code93Extended, EAN13, EAN8, Interleaved2of5, MSI, Standard2of5, UPCA, UPCE, ISBN, GS1Code128, Postnet, Planet EAN14, SCC14, SSCC18, ITF14, SingaporePost ... 2D: Aztec, DataMatrix, PDf417, QR code ...
17+
supported symbologies: 1D: Codabar, Code11, Code128, Code39, Code39FullASCII Code93, Code93Extended, EAN13, EAN8, Interleaved2of5, MSI, Standard2of5, UPCA, UPCE, ISBN, GS1Code128, Postnet, Planet EAN14, SCC14, SSCC18, ITF14, SingaporePost ... 2D: Aztec, DataMatrix, PDf417, QR code ...
1818

1919
--------------------
2020

@@ -55,7 +55,8 @@ supported symbologies: 1D: Codabar, Code11, Code128, Code39Standard, Code39Exten
5555
| [setBarcodeType(BaseEncodeType value)](#setBarcodeType-com.aspose.barcode.generation.BaseEncodeType-) | Barcode symbology type. |
5656
| [setCodeText(byte[] codeBytes)](#setCodeText-byte---) | Set codetext as sequence of bytes. |
5757
| [setCodeText(String value)](#setCodeText-java.lang.String-) | Text to be encoded. |
58-
| [setCodeText(String codeText, Charset encoding)](#setCodeText-java.lang.String-java.nio.charset.Charset-) | Encodes codetext with byte order mark (BOM) using specified encoding. |
58+
| [setCodeText(String codeText, Charset encoding)](#setCodeText-java.lang.String-java.nio.charset.Charset-) | Encodes codetext with byte order mark (BOM), using specified encoding. |
59+
| [setCodeText(String codeText, Charset encoding, boolean insertBOM)](#setCodeText-java.lang.String-java.nio.charset.Charset-boolean-) | Encodes codetext with optional byte order mark (BOM) insertion, using specified encoding: like UTF8, UTF16, UTF32, e.t.c. |
5960
| [toString()](#toString--) | |
6061
| [wait()](#wait--) | |
6162
| [wait(long arg0)](#wait-long-) | |
@@ -345,13 +346,60 @@ public void setCodeText(String codeText, Charset encoding)
345346
```
346347
347348
348-
Encodes codetext with byte order mark (BOM) using specified encoding.
349+
Encodes codetext with byte order mark (BOM), using specified encoding. This sample shows how to use SetCodeText with 1D and 2D barcodes
350+
351+
```
352+
BarcodeGenerator gen = new BarcodeGenerator(EncodeTypes.CODE_128);
353+
gen.setCodeText("123ABCD", StandardCharsets.US_ASCII);
354+
gen.save("barcode.png", BarCodeImageFormat.PNG);
355+
356+
BarcodeGenerator gen = new BarcodeGenerator(EncodeTypes.QR);
357+
gen.setCodeText("123ABCD", StandardCharsets.ISO_8859_1, true);
358+
gen.save("barcode.png", BarCodeImageFormat.PNG);
359+
360+
BarcodeGenerator gen = new BarcodeGenerator(EncodeTypes.QR);
361+
gen.setCodeText("123ABCD", Encoding.UTF_8, false);
362+
gen.save("barcode.png", BarCodeImageFormat.PNG);
363+
```
364+
365+
**Parameters:**
366+
| Parameter | Type | Description |
367+
| --- | --- | --- |
368+
| codeText | java.lang.String | CodeText string |
369+
| encoding | java.nio.charset.Charset | Applied encoding |
370+
371+
### setCodeText(String codeText, Charset encoding, boolean insertBOM) {#setCodeText-java.lang.String-java.nio.charset.Charset-boolean-}
372+
```
373+
public void setCodeText(String codeText, Charset encoding, boolean insertBOM)
374+
```
375+
376+
377+
Encodes codetext with optional byte order mark (BOM) insertion, using specified encoding: like UTF8, UTF16, UTF32, e.t.c. 1D barcodes should use Encoding ASCII or ISO/IEC 8859-1. 2D barcodes should use Encoding UTF8. Detailed description you can find in the @see [documentation][]
378+
379+
--------------------
380+
381+
> ```
382+
> This sample shows how to use setCodeText
383+
>
384+
>
385+
> BarcodeGenerator gen = new BarcodeGenerator(EncodeTypes.CODE_128);
386+
> gen.setCodeText("123ABCD", StandardCharsets.ISO_8859_1, true);
387+
> gen.save("barcode.png", BarCodeImageFormat.PNG);
388+
>
389+
> BarcodeGenerator gen = new BarcodeGenerator(EncodeTypes.CODE_128);
390+
> gen.setCodeText("123ABCD", StandardCharsets.UTF_8, false);
391+
> gen.save("barcode.png", BarCodeImageFormat.PNG);
392+
> ```
393+
394+
395+
[documentation]: https://docs.aspose.com/barcode/java/how-to-use-insert-bom-parameter/
349396
350397
**Parameters:**
351398
| Parameter | Type | Description |
352399
| --- | --- | --- |
353400
| codeText | java.lang.String | CodeText string |
354401
| encoding | java.nio.charset.Charset | Applied encoding |
402+
| insertBOM | boolean | flag indicates insertion of the Encoding byte order mark (BOM). In case, the Encoding requires byte order mark (BOM) insertion: like UTF8, UTF16, UTF32, e.t.c. and flag is set to true, the BOM is added, in case of setting flag to false, the BOM insertion is ignored. |
355403
356404
### toString() {#toString--}
357405
```

0 commit comments

Comments
 (0)