Skip to content

Commit 461f63f

Browse files
alex-grininalex-grinin
committed
Javadoc API for Aspose.Barcode for Java release 25.8 is updated
1 parent b868daa commit 461f63f

File tree

8 files changed

+310
-88
lines changed

8 files changed

+310
-88
lines changed

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

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Stores recognized barcode data like SingleDecodeType type, string codetext,
4545
| [getClass()](#getClass--) | |
4646
| [getCodeBytes()](#getCodeBytes--) | Gets the encoded code bytes |
4747
| [getCodeText()](#getCodeText--) | Gets the code text |
48-
| [getCodeText(Charset encoding)](#getCodeText-java.nio.charset.Charset-) | Gets the code text with encoding. |
48+
| [getCodeText(Charset charset)](#getCodeText-java.nio.charset.Charset-) | Gets the code text with encoding. |
4949
| [getCodeType()](#getCodeType--) | Gets the barcode type |
5050
| [getCodeTypeName()](#getCodeTypeName--) | Gets the name of the barcode type |
5151
| [getConfidence()](#getConfidence--) | Gets recognition confidence level of the recognized barcode |
@@ -131,18 +131,34 @@ Value: The code text of the barcode
131131
132132
**Returns:**
133133
java.lang.String
134-
### getCodeText(Charset encoding) {#getCodeText-java.nio.charset.Charset-}
134+
### getCodeText(Charset charset) {#getCodeText-java.nio.charset.Charset-}
135135
```
136-
public String getCodeText(Charset encoding)
136+
public String getCodeText(Charset charset)
137137
```
138138
139139
140140
Gets the code text with encoding.
141141
142+
--------------------
143+
144+
> ```
145+
> This example shows how to use ```
146+
> GetCodeText
147+
> ```:
148+
>
149+
> BarcodeGenerator gen = new BarcodeGenerator(EncodeTypes.DATA_MATRIX);
150+
> gen.setCodeText("\u8eca\u7a2e\u540d", Charset.forName("932"));
151+
> gen.save("barcode.png", BarCodeImageFormat.PNG);
152+
>
153+
> BarCodeReader reader = new BarCodeReader("barcode.png", DecodeType.DATA_MATRIX);
154+
> for(BarCodeResult result : reader.readBarCodes())
155+
> System.out.println("BarCode CodeText: " + result.getCodeText(Charset.forName("932")));
156+
> ```
157+
142158
**Parameters:**
143159
| Parameter | Type | Description |
144160
| --- | --- | --- |
145-
| encoding | java.nio.charset.Charset | The encoding for codetext. |
161+
| charset | java.nio.charset.Charset | The encoding for codetext. |
146162
147163
**Returns:**
148164
java.lang.String - A string containing recognized code text.

‎english/java/com.aspose.barcode.barcoderecognition/barcodesettings/_index.md‎

Lines changed: 51 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,34 @@ public boolean getDetectEncoding()
8484
```
8585

8686

87-
The flag which force engine to detect codetext encoding for Unicode codesets. Default value is true. Example BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.QR); generator.setCodeText("\\u0421\\u043b\\u043e\\u0432\\u043e", Charset.forName("UTF-8")); BufferedImage im = generator.generateBarcodeImage(); //detects encoding for Unicode codesets is enabled BarCodeReader reader = new BarCodeReader(im, DecodeType.QR); reader.getBarcodeSettings().setDetectEncoding(true); for(BarCodeResult result : reader.readBarCodes()) System.out.println("BarCode CodeText: " + result.getCodeText()); //detect encoding is disabled BarCodeReader reader = new BarCodeReader(im, DecodeType.QR); reader.getBarcodeSettings().setDetectEncoding(false); for(BarCodeResult result : reader.readBarCodes()) System.out.println("BarCode CodeText: " + result.getCodeText());
87+
The flag which force engine to detect codetext encoding for Unicode codesets. Default value is true.
88+
89+
--------------------
90+
91+
> ```
92+
> This sample shows how to detect text encoding on the fly if DetectEncoding is enabled
93+
>
94+
>
95+
> ByteArrayOutputStream ms = new ByteArrayOutputStream();
96+
> BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.QR);
97+
> generator.setCodeText("\u0421\u043b\u043e\u0432\u043e", StandardCharsets.UTF_8);
98+
> generator.save(ms, BarCodeImageFormat.PNG);
99+
>
100+
> BarCodeReader reader = new BarCodeReader(new ByteArrayInputStream(ms.toByteArray()), DecodeType.QR);
101+
> reader.getBarcodeSettings().setDetectEncoding(true);
102+
> for (BarCodeResult result : reader.readBarCodes())
103+
> System.out.println("BarCode CodeText: " + result.getCodeText());
104+
> //detect encoding is disabled
105+
> reader = new BarCodeReader(new ByteArrayInputStream(ms.toByteArray()), DecodeType.QR);
106+
> reader.getBarcodeSettings().setDetectEncoding(false);
107+
> for (BarCodeResult result : reader.readBarCodes())
108+
> System.out.println("BarCode CodeText: " + result.getCodeText());
109+
> ```
110+
111+
Value: The flag which force engine to detect codetext encoding for Unicode codesets
88112
89113
**Returns:**
90-
boolean - The flag which force engine to detect codetext encoding for Unicode codesets
114+
boolean
91115
### getStripFNC() {#getStripFNC--}
92116
```
93117
public boolean getStripFNC()
@@ -143,7 +167,31 @@ public void setDetectEncoding(boolean value)
143167
```
144168
145169
146-
The flag which force engine to detect codetext encoding for Unicode codesets. Default value is true. Example BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.QR, "\\u0421\\u043b\\u043e\\u0432\\u043e")) generator.getParameters().getBarcode().getQR().setCodeTextEncoding(Charset.forName("UTF-8")); BufferedImage im = generator.generateBarcodeImage(); //detects encoding for Unicode codesets is enabled BarCodeReader reader = new BarCodeReader(im, DecodeType.QR); reader.getBarcodeSettings().setDetectEncoding(true); for(BarCodeResult result : reader.readBarCodes()) System.out.println("BarCode CodeText: " + result.getCodeText()); //detect encoding is disabled BarCodeReader reader = new BarCodeReader(im, DecodeType.QR); reader.getBarcodeSettings().setDetectEncoding(false); for(BarCodeResult result : reader.readBarCodes()) System.out.println("BarCode CodeText: " + result.getCodeText());
170+
The flag which force engine to detect codetext encoding for Unicode codesets. Default value is true.
171+
172+
--------------------
173+
174+
> ```
175+
> This sample shows how to detect text encoding on the fly if DetectEncoding is enabled
176+
>
177+
>
178+
> ByteArrayOutputStream ms = new ByteArrayOutputStream();
179+
> BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.QR);
180+
> generator.setCodeText("\u0421\u043b\u043e\u0432\u043e", StandardCharsets.UTF_8);
181+
> generator.save(ms, BarCodeImageFormat.PNG);
182+
>
183+
> BarCodeReader reader = new BarCodeReader(new ByteArrayInputStream(ms.toByteArray()), DecodeType.QR);
184+
> reader.getBarcodeSettings().setDetectEncoding(true);
185+
> for (BarCodeResult result : reader.readBarCodes())
186+
> System.out.println("BarCode CodeText: " + result.getCodeText());
187+
> //detect encoding is disabled
188+
> reader = new BarCodeReader(new ByteArrayInputStream(ms.toByteArray()), DecodeType.QR);
189+
> reader.getBarcodeSettings().setDetectEncoding(false);
190+
> for (BarCodeResult result : reader.readBarCodes())
191+
> System.out.println("BarCode CodeText: " + result.getCodeText());
192+
> ```
193+
194+
Value: The flag which force engine to detect codetext encoding for Unicode codesets
147195
148196
**Parameters:**
149197
| Parameter | Type | Description |

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

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ Base class for MultyDecodeType and SingleDecodeType.
2727
| Method | Description |
2828
| --- | --- |
2929
| [containsAny(BaseDecodeType[] types)](#containsAny-com.aspose.barcode.barcoderecognition.BaseDecodeType...-) | Determines whether any of the given decode types is included into |
30-
| [equals(Object obj)](#equals-java.lang.Object-) | Returns a value indicating whether this instance is equal to a specified [BaseDecodeType](../../com.aspose.barcode.barcoderecognition/basedecodetype) value. |
30+
| [equals(MultyDecodeType other)](#equals-com.aspose.barcode.barcoderecognition.MultyDecodeType-) | Returns a value indicating whether this instance is equal to a specified [BaseDecodeType](../../com.aspose.barcode.barcoderecognition/basedecodetype) value. |
31+
| [equals(SingleDecodeType other)](#equals-com.aspose.barcode.barcoderecognition.SingleDecodeType-) | Returns a value indicating whether this instance is equal to a specified [BaseDecodeType](../../com.aspose.barcode.barcoderecognition/basedecodetype) value. |
32+
| [equals(Object other)](#equals-java.lang.Object-) | Returns a value indicating whether this instance is equal to a specified [BaseDecodeType](../../com.aspose.barcode.barcoderecognition/basedecodetype) value. |
3133
| [getClass()](#getClass--) | |
3234
| [hashCode()](#hashCode--) | |
3335
| [notify()](#notify--) | |
@@ -54,9 +56,9 @@ Determines whether any of the given decode types is included into
5456
5557
**Returns:**
5658
boolean - Value is a true if any types are included into.
57-
### equals(Object obj) {#equals-java.lang.Object-}
59+
### equals(MultyDecodeType other) {#equals-com.aspose.barcode.barcoderecognition.MultyDecodeType-}
5860
```
59-
public boolean equals(Object obj)
61+
public boolean equals(MultyDecodeType other)
6062
```
6163
6264
@@ -65,7 +67,37 @@ Returns a value indicating whether this instance is equal to a specified [BaseDe
6567
**Parameters:**
6668
| Parameter | Type | Description |
6769
| --- | --- | --- |
68-
| obj | java.lang.Object | An System.Object value to compare to this instance. |
70+
| other | [MultyDecodeType](../../com.aspose.barcode.barcoderecognition/multydecodetype) | An java.lang.Object value to compare to this instance. |
71+
72+
**Returns:**
73+
boolean - True if obj has the same value as this instance; otherwise, false.
74+
### equals(SingleDecodeType other) {#equals-com.aspose.barcode.barcoderecognition.SingleDecodeType-}
75+
```
76+
public boolean equals(SingleDecodeType other)
77+
```
78+
79+
80+
Returns a value indicating whether this instance is equal to a specified [BaseDecodeType](../../com.aspose.barcode.barcoderecognition/basedecodetype) value.
81+
82+
**Parameters:**
83+
| Parameter | Type | Description |
84+
| --- | --- | --- |
85+
| other | [SingleDecodeType](../../com.aspose.barcode.barcoderecognition/singledecodetype) | An java.lang.Object value to compare to this instance. |
86+
87+
**Returns:**
88+
boolean - True if obj has the same value as this instance; otherwise, false.
89+
### equals(Object other) {#equals-java.lang.Object-}
90+
```
91+
public boolean equals(Object other)
92+
```
93+
94+
95+
Returns a value indicating whether this instance is equal to a specified [BaseDecodeType](../../com.aspose.barcode.barcoderecognition/basedecodetype) value.
96+
97+
**Parameters:**
98+
| Parameter | Type | Description |
99+
| --- | --- | --- |
100+
| other | java.lang.Object | An java.lang.Object value to compare to this instance. |
69101
70102
**Returns:**
71103
boolean - True if obj has the same value as this instance; otherwise, false.

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

Lines changed: 41 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,13 @@ Composite decode type.
3535
| [add(SingleDecodeType singleType)](#add-com.aspose.barcode.barcoderecognition.SingleDecodeType-) | Adds one more [SingleDecodeType](../../com.aspose.barcode.barcoderecognition/singledecodetype) to the MultyDecodeType. |
3636
| [containsAll(BaseDecodeType[] barcodeTypes)](#containsAll-com.aspose.barcode.barcoderecognition.BaseDecodeType...-) | Check if this contains all types from barcode types. |
3737
| [containsAny(BaseDecodeType[] decodeTypes)](#containsAny-com.aspose.barcode.barcoderecognition.BaseDecodeType...-) | Is contain any of types |
38+
| [equals(MultyDecodeType other)](#equals-com.aspose.barcode.barcoderecognition.MultyDecodeType-) | Returns a value indicating whether this instance is equal to a specified value. |
39+
| [equals(SingleDecodeType other)](#equals-com.aspose.barcode.barcoderecognition.SingleDecodeType-) | Returns a value indicating whether this decode types collection contains only specified value. |
3840
| [equals(Object obj)](#equals-java.lang.Object-) | Returns a value indicating whether this instance is equal to a specified MultyDecodeType value. |
3941
| [exclude(SingleDecodeType singleType)](#exclude-com.aspose.barcode.barcoderecognition.SingleDecodeType-) | Excludes SingleDecodeType from the MultyDecodeType and returns new MultyDecodeType instance. |
4042
| [getClass()](#getClass--) | |
41-
| [getGetSingleTypesCount()](#getGetSingleTypesCount--) | Returns a number of single types. |
4243
| [getSingleTypes()](#getSingleTypes--) | Represents a list of single types. |
44+
| [getSingleTypesCount()](#getSingleTypesCount--) | Returns a number of single types. |
4345
| [hashCode()](#hashCode--) | Returns the hash code for this instance. |
4446
| [notify()](#notify--) | |
4547
| [notifyAll()](#notifyAll--) | |
@@ -119,6 +121,36 @@ Is contain any of types
119121
120122
**Returns:**
121123
boolean - Value is a true if any types are included into
124+
### equals(MultyDecodeType other) {#equals-com.aspose.barcode.barcoderecognition.MultyDecodeType-}
125+
```
126+
public boolean equals(MultyDecodeType other)
127+
```
128+
129+
130+
Returns a value indicating whether this instance is equal to a specified value.
131+
132+
**Parameters:**
133+
| Parameter | Type | Description |
134+
| --- | --- | --- |
135+
| other | [MultyDecodeType](../../com.aspose.barcode.barcoderecognition/multydecodetype) | An java.lang.Object value to compare to this instance. |
136+
137+
**Returns:**
138+
boolean -
139+
### equals(SingleDecodeType other) {#equals-com.aspose.barcode.barcoderecognition.SingleDecodeType-}
140+
```
141+
public boolean equals(SingleDecodeType other)
142+
```
143+
144+
145+
Returns a value indicating whether this decode types collection contains only specified value.
146+
147+
**Parameters:**
148+
| Parameter | Type | Description |
149+
| --- | --- | --- |
150+
| other | [SingleDecodeType](../../com.aspose.barcode.barcoderecognition/singledecodetype) | An java.lang.Object value to compare to this instance. |
151+
152+
**Returns:**
153+
boolean - if this collection contains only specified decode type; otherwise, **false**.
122154
### equals(Object obj) {#equals-java.lang.Object-}
123155
```
124156
public boolean equals(Object obj)
@@ -159,26 +191,26 @@ public final native Class<?> getClass()
159191
160192
**Returns:**
161193
java.lang.Class<?>
162-
### getGetSingleTypesCount() {#getGetSingleTypesCount--}
194+
### getSingleTypes() {#getSingleTypes--}
163195
```
164-
public int getGetSingleTypesCount()
196+
public List<SingleDecodeType> getSingleTypes()
165197
```
166198
167199
168-
Returns a number of single types.
200+
Represents a list of single types.
169201
170202
**Returns:**
171-
int
172-
### getSingleTypes() {#getSingleTypes--}
203+
java.util.List<com.aspose.barcode.barcoderecognition.SingleDecodeType> - List of single types
204+
### getSingleTypesCount() {#getSingleTypesCount--}
173205
```
174-
public List<SingleDecodeType> getSingleTypes()
206+
public int getSingleTypesCount()
175207
```
176208
177209
178-
Represents a list of single types.
210+
Returns a number of single types.
179211
180212
**Returns:**
181-
java.util.List<com.aspose.barcode.barcoderecognition.SingleDecodeType> - List of single types
213+
int
182214
### hashCode() {#hashCode--}
183215
```
184216
public int hashCode()

‎english/java/com.aspose.barcode.barcoderecognition/singledecodetype/_index.md‎

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,13 @@ Single decode type. See decode type to get instance.
2121
>
2222
> SingleDecodeType singleType = DecodeType.QR
2323
> ```
24-
## Constructors
25-
26-
| Constructor | Description |
27-
| --- | --- |
28-
| [SingleDecodeType(short typeIndex, String typeName)](#SingleDecodeType-short-java.lang.String-) | Initializes a new instance of [SingleDecodeType](../../com.aspose.barcode.barcoderecognition/singledecodetype) class by type index and name |
2924
## Methods
3025
3126
| Method | Description |
3227
| --- | --- |
3328
| [containsAny(BaseDecodeType[] types)](#containsAny-com.aspose.barcode.barcoderecognition.BaseDecodeType...-) | Returns a value indicating whether this instance is included into the list specified. |
29+
| [equals(MultyDecodeType other)](#equals-com.aspose.barcode.barcoderecognition.MultyDecodeType-) | |
30+
| [equals(SingleDecodeType other)](#equals-com.aspose.barcode.barcoderecognition.SingleDecodeType-) | |
3431
| [equals(Object obj)](#equals-java.lang.Object-) | Returns a value indicating whether this instance is equal to a specified [SingleDecodeType](../../com.aspose.barcode.barcoderecognition/singledecodetype) value. |
3532
| [getClass()](#getClass--) | |
3633
| [getString()](#getString--) | Converts the instance of SingleDecodeType to its equivalent string representation, using the following format: "Index:-1; Name:None". |
@@ -48,35 +45,51 @@ Single decode type. See decode type to get instance.
4845
| [wait()](#wait--) | |
4946
| [wait(long arg0)](#wait-long-) | |
5047
| [wait(long arg0, int arg1)](#wait-long-int-) | |
51-
### SingleDecodeType(short typeIndex, String typeName) {#SingleDecodeType-short-java.lang.String-}
48+
### containsAny(BaseDecodeType[] types) {#containsAny-com.aspose.barcode.barcoderecognition.BaseDecodeType...-}
5249
```
53-
public SingleDecodeType(short typeIndex, String typeName)
50+
public boolean containsAny(BaseDecodeType[] types)
5451
```
5552
5653
57-
Initializes a new instance of [SingleDecodeType](../../com.aspose.barcode.barcoderecognition/singledecodetype) class by type index and name
54+
Returns a value indicating whether this instance is included into the list specified.
5855
5956
**Parameters:**
6057
| Parameter | Type | Description |
6158
| --- | --- | --- |
62-
| typeIndex | short | Gets an index of decode type |
63-
| typeName | java.lang.String | Gets a name of decode type |
59+
| types | [BaseDecodeType\[\]](../../com.aspose.barcode.barcoderecognition/basedecodetype) | Array of single and multy decode types |
6460
65-
### containsAny(BaseDecodeType[] types) {#containsAny-com.aspose.barcode.barcoderecognition.BaseDecodeType...-}
61+
**Returns:**
62+
boolean - Value is a true if any types are included into
63+
### equals(MultyDecodeType other) {#equals-com.aspose.barcode.barcoderecognition.MultyDecodeType-}
6664
```
67-
public boolean containsAny(BaseDecodeType[] types)
65+
public boolean equals(MultyDecodeType other)
6866
```
6967
7068
71-
Returns a value indicating whether this instance is included into the list specified.
69+
Returns a value indicating whether this instance is equal to a specified [BaseDecodeType](../../com.aspose.barcode.barcoderecognition/basedecodetype) value.
7270
7371
**Parameters:**
7472
| Parameter | Type | Description |
7573
| --- | --- | --- |
76-
| types | [BaseDecodeType\[\]](../../com.aspose.barcode.barcoderecognition/basedecodetype) | Array of single and multy decode types |
74+
| other | [MultyDecodeType](../../com.aspose.barcode.barcoderecognition/multydecodetype) | |
7775
7876
**Returns:**
79-
boolean - Value is a true if any types are included into
77+
boolean
78+
### equals(SingleDecodeType other) {#equals-com.aspose.barcode.barcoderecognition.SingleDecodeType-}
79+
```
80+
public boolean equals(SingleDecodeType other)
81+
```
82+
83+
84+
Returns a value indicating whether this instance is equal to a specified [BaseDecodeType](../../com.aspose.barcode.barcoderecognition/basedecodetype) value.
85+
86+
**Parameters:**
87+
| Parameter | Type | Description |
88+
| --- | --- | --- |
89+
| other | [SingleDecodeType](../../com.aspose.barcode.barcoderecognition/singledecodetype) | |
90+
91+
**Returns:**
92+
boolean
8093
### equals(Object obj) {#equals-java.lang.Object-}
8194
```
8295
public boolean equals(Object obj)

0 commit comments

Comments
 (0)