Skip to content

Commit 20030dc

Browse files
DMGithubPublisherDMGithubPublisher
authored
Merge pull request #85 from dynamsoft-docs/preview
update to internal commit b8f7159e
2 parents 9dacf36 + 2f3aec2 commit 20030dc

File tree

13 files changed

+347
-21
lines changed

13 files changed

+347
-21
lines changed

‎_includes/sidelist-programming/programming-java.html‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
<li><a>Classes</a>
1717
<ul>
1818
<li><a href="{{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/buffered-items-manager.html" class="otherLinkColour">BufferedItemsManager</a></li>
19+
<li><a href="{{ site.dcvb_java_api }}capture-vision-router/capture-vision-error.html" class="otherLinkColour">CaptureVisionError</a></li>
20+
<li><a href="{{ site.dcvb_java_api }}capture-vision-router/capture-vision-execption.html" class="otherLinkColour">CaptureVisionException</a></li>
1921
<li><a href="{{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/capture-vision-router-module.html" class="otherLinkColour">CaptureVisionRouterModule</a></li>
2022
<li><a href="{{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/captured-result-filter.html" class="otherLinkColour">CapturedResultFilter</a></li>
2123
<li><a href="{{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/captured-result-receiver.html" class="otherLinkColour">CapturedResultReceiver</a></li>
@@ -46,6 +48,7 @@
4648
<ul>
4749
<li><a href="{{ site.dbr_java_api }}aztec-details.html" class="otherLinkColour">AztecDetails</a></li>
4850
<li><a href="{{ site.dbr_java_api }}barcode-details.html" class="otherLinkColour">BarcodeDetails</a></li>
51+
<li><a href="{{ site.dbr_java_api }}barcode-reader-exception.html" class="otherLinkColour">BarcodeReaderException</a></li>
4952
<li><a href="{{ site.dbr_java_api }}barcode-reader-module.html" class="otherLinkColour">BarcodeReaderModule</a></li>
5053
<li><a href="{{ site.dbr_java_api }}barcode-result-item.html" class="otherLinkColour">BarcodeResultItem</a></li>
5154
<li><a href="{{ site.dbr_java_api }}candidate-barcode-zone.html" class="otherLinkColour">CandidateBarcodeZone</a></li>
@@ -86,6 +89,7 @@
8689
<li><a href="{{ site.dlr_java_api }}buffered-character-item.html" class="otherLinkColour">BufferedCharacterItem</a></li>
8790
<li><a href="{{ site.dlr_java_api }}character-cluster.html" class="otherLinkColour">CharacterCluster</a></li>
8891
<li><a href="{{ site.dlr_java_api }}character-result.html" class="otherLinkColour">CharacterResult</a></li>
92+
<li><a href="{{ site.dlr_java_api }}label-recognizer-exception.html" class="otherLinkColour">LabelRecognizerException</a></li>
8993
<li><a href="{{ site.dlr_java_api }}label-recognizer-module.html" class="otherLinkColour">LabelRecognizerModule</a></li>
9094
<li><a href="{{ site.dlr_java_api }}localized-text-line-element.html" class="otherLinkColour">LocalizedTextLineElement</a></li>
9195
<li><a href="{{ site.dlr_java_api }}localized-text-lines-unit.html" class="otherLinkColour">LocalizedTextLinesUnit</a></li>
@@ -117,6 +121,7 @@
117121
<li><a href="{{ site.ddn_java_api }}deskewed-image-element.html" class="otherLinkColour">DeskewedImageElement</a></li>
118122
<li><a href="{{ site.ddn_java_api }}deskewed-image-result-item.html" class="otherLinkColour">DeskewedImageResultItem</a></li>
119123
<li><a href="{{ site.ddn_java_api }}deskewed-image-unit.html" class="otherLinkColour">DeskewedImageUnit</a></li>
124+
<li><a href="{{ site.ddn_java_api }}document-normalizer-exception.html" class="otherLinkColour">DocumentNormalizerException</a></li>
120125
<li><a href="{{ site.ddn_java_api }}document-normalizer-module.html" class="otherLinkColour">DocumentNormalizerModule</a></li>
121126
<li><a href="{{ site.ddn_java_api }}enhanced-image-element.html" class="otherLinkColour">EnhancedImageElement</a></li>
122127
<li><a href="{{ site.ddn_java_api }}enhanced-image-result-item.html" class="otherLinkColour">EnhancedImageResultItem</a></li>
@@ -164,6 +169,8 @@
164169
<li><a href="{{ site.dcvb_java_api }}core/intermediate-results/colour-image-unit.html" class="otherLinkColour">ColourImageUnit</a></li>
165170
<li><a href="{{ site.dcvb_java_api }}core/intermediate-results/contours-unit.html" class="otherLinkColour">ContoursUnit</a></li>
166171
<li><a href="{{ site.dcvb_java_api }}core/basic-classes/contour.html" class="otherLinkColour">Contour</a></li>
172+
<li><a href="{{ site.dcvb_java_api }}core/core-error.html" class="otherLinkColour">CoreError</a></li>
173+
<li><a href="{{ site.dcvb_java_api }}core/core-exception.html" class="otherLinkColour">CoreException</a></li>
167174
<li><a href="{{ site.dcvb_java_api }}core/basic-classes/core-module.html" class="otherLinkColour">CoreModule</a></li>
168175
<li><a href="{{ site.dcvb_java_api }}core/basic-classes/corner.html" class="otherLinkColour">Corner</a></li>
169176
<li><a href="{{ site.dcvb_java_api }}core/basic-classes/edge.html" class="otherLinkColour">Edge</a></li>
@@ -241,6 +248,7 @@
241248
<li><a href="{{ site.dcvb_java_api }}utility/image-drawer.html" class="otherLinkColour">ImageDrawer</a></li>
242249
<li><a href="{{ site.dcvb_java_api }}utility/multi-frame-result-cross-filter.html" class="otherLinkColour">MultiFrameResultCrossFilter</a></li>
243250
<li><a href="{{ site.dcvb_java_api }}utility/proactive-image-source-adapter.html" class="otherLinkColour">ProactiveImageSourceAdapter</a></li>
251+
<li><a href="{{ site.dcvb_java_api }}utility/utility-exception.html" class="otherLinkColour">UtilityException</a></li>
244252
<li><a href="{{ site.dcvb_java_api }}utility/utility-module.html" class="otherLinkColour">UtilityModule</a></li>
245253
</ul>
246254
</li>
@@ -253,6 +261,8 @@
253261
</li>
254262
<li><a>DynamsoftLicense</a>
255263
<ul>
264+
<li><a href="{{ site.dcvb_java_api }}license/license-error.html" class="otherLinkColour">LicenseError</a></li>
265+
<li><a href="{{ site.dcvb_java_api }}license/license-exception.html" class="otherLinkColour">LicenseException</a></li>
256266
<li><a href="{{ site.dcvb_java_api }}license/license-manager.html" class="otherLinkColour">LicenseManager</a></li>
257267
<li><a href="{{ site.dcvb_java_api }}license/license-module.html" class="otherLinkColour">LicenseModule</a></li>
258268
</ul>

‎programming/cplusplus/api-reference/core/enum-error-code.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,8 @@ typedef enum ErrorCode
153153
EC_INSTANCE_COUNT_OVER_LIMIT = -20008,
154154
/** Trial License */
155155
EC_TRIAL_LICENSE = -20010,
156+
/** The license is not valid for current version */
157+
EC_LICENSE_VERSION_NOT_MATCH = -20011,
156158
/**Online license validation failed due to network issues. Using cached license information for validation*/
157159
EC_LICENSE_CACHE_USED = -20012,
158160
/*License authentication failed: quota exceeded.*/

‎programming/dotnet/api-reference/core/enum-error-code.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,8 @@ public enum EnumErrorCode
152152
EC_INSTANCE_COUNT_OVER_LIMIT = -20008,
153153
/** Trial License */
154154
EC_TRIAL_LICENSE = -20010,
155+
/** The license is not valid for current version */
156+
EC_LICENSE_VERSION_NOT_MATCH = -20011,
155157
/**Online license validation failed due to network issues. Using cached license information for validation*/
156158
EC_LICENSE_CACHE_USED = -20012,
157159
/*License authentication failed: quota exceeded.*/

‎programming/java/api-reference/capture-vision-router/auxiliary-classes/intermediate-result-manager.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Returns void.
4444

4545
**Exception**
4646

47-
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/capture-vision-exception.html)
47+
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/capture-vision-exception.html)
4848

4949
**See Also**
5050

@@ -68,7 +68,7 @@ Returns void.
6868

6969
**Exception**
7070

71-
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/capture-vision-exception.html)
71+
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/capture-vision-exception.html)
7272

7373
**See Also**
7474

‎programming/java/api-reference/capture-vision-router/capture-vision-error.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
layout: default-layout
3+
title: CaptureVisionError Class - Dynamsoft Capture Vision Router Module Java Edition API Reference
4+
description: Definition of CaptureVisionError class in Dynamsoft Capture Vision Router Module Java Edition.
5+
keywords: capture vision router module, java
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
---
9+
10+
# CaptureVisionError
11+
12+
The `CaptureVisionError` class represents an error object that contains error code and error string information. This class extends [`CoreError`]({{ site.dcvb_java_api }}core/core-error.html) and provides specific error handling for capture vision router operations.
13+
14+
## Definition
15+
16+
*Package:* com.dynamsoft.cvr
17+
18+
```java
19+
public class CaptureVisionError extends CoreError
20+
```
21+
22+
## Inheritance
23+
24+
`CaptureVisionError` -> [`CoreError`]({{ site.dcvb_java_api }}core/core-error.html)
25+
26+
## Inherited Members
27+
28+
Since `CaptureVisionError` extends [`CoreError`]({{ site.dcvb_java_api }}core/core-error.html), it inherits all the properties and methods from the parent class, including:
29+
30+
- `getErrorCode()` - Returns the error code.
31+
- `getErrorString()` - Returns the error string.
32+

‎programming/java/api-reference/capture-vision-router/capture-vision-exception.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
layout: default-layout
3+
title: CaptureVisionException Class - Dynamsoft Capture Vision Router Module Java Edition API Reference
4+
description: Definition of CaptureVisionException class in Dynamsoft Capture Vision Router Module Java Edition.
5+
keywords: capture vision router module, java
6+
needAutoGenerateSidebar: true
7+
needGenerateH3Content: true
8+
---
9+
10+
# CaptureVisionException
11+
12+
The `CaptureVisionException` class is the base exception class used by Dynamsoft Capture Vision Router module. This class extends the standard Java `Exception` class and provides additional error code and error string information for more detailed error handling.
13+
14+
## Definition
15+
16+
*Package:* com.dynamsoft.cvr
17+
18+
```java
19+
public class CaptureVisionException extends Exception
20+
```
21+
22+
## Inheritance
23+
24+
`CaptureVisionException` -> `Exception` -> `Throwable`
25+
26+
## Methods
27+
28+
| Method | Description |
29+
| ------ | ----------- |
30+
| [`getErrorCode()`](#geterrorcode) | Returns the error code associated with the exception. |
31+
| [`getErrorString()`](#geterrorstring) | Returns the error string associated with the exception. |
32+
33+
### getErrorCode()
34+
35+
Returns the error code associated with the exception.
36+
37+
```java
38+
public int getErrorCode()
39+
```
40+
41+
**Return Value**
42+
43+
The error code as an integer value.
44+
45+
**See Also**
46+
47+
[EnumErrorCode]({{ site.dcvb_java_api }}core/enum-error-code.html)
48+
49+
### getErrorString()
50+
51+
Returns the error string associated with the exception.
52+
53+
```java
54+
public String getErrorString()
55+
```
56+
57+
**Return Value**
58+
59+
The error string that provides additional details about the error.
60+
61+
## Inherited Members
62+
63+
Since `CaptureVisionException` extends `Exception`, it also inherits all standard exception methods such as `getMessage()`, `getCause()`, `printStackTrace()`, etc.
64+

‎programming/java/api-reference/capture-vision-router/multiple-file-processing.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public void setInput(ImageSourceAdapter pAdapter) throws CaptureVisionException
4040

4141
**Exceptions**
4242

43-
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/capture-vision-exception.html)
43+
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/capture-vision-exception.html)
4444

4545
**See Also**
4646

@@ -84,7 +84,7 @@ public void addCaptureStateListener(CaptureStateListener listener) throws Captur
8484

8585
**Exceptions**
8686

87-
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/capture-vision-exception.html)
87+
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/capture-vision-exception.html)
8888

8989
**See Also**
9090

@@ -104,7 +104,7 @@ public void removeCaptureStateListener(CaptureStateListener listener) throws Cap
104104

105105
**Exceptions**
106106

107-
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/capture-vision-exception.html)
107+
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/capture-vision-exception.html)
108108

109109
**See Also**
110110

@@ -124,7 +124,7 @@ public void addImageSourceStateListener(ImageSourceStateListener listener) throw
124124

125125
**Exceptions**
126126

127-
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/capture-vision-exception.html)
127+
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/capture-vision-exception.html)
128128

129129
**See Also**
130130

@@ -144,7 +144,7 @@ public void removeImageSourceStateListener(ImageSourceStateListener listener) th
144144

145145
**Exceptions**
146146

147-
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/capture-vision-exception.html)
147+
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/capture-vision-exception.html)
148148

149149
**See Also**
150150

@@ -164,7 +164,7 @@ public void addResultReceiver(CapturedResultReceiver receiver) throws CaptureVis
164164

165165
**Exceptions**
166166

167-
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/capture-vision-exception.html)
167+
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/capture-vision-exception.html)
168168

169169
**See Also**
170170

@@ -184,7 +184,7 @@ public void removeResultReceiver(CapturedResultReceiver receiver) throws Capture
184184

185185
**Exceptions**
186186

187-
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/capture-vision-exception.html)
187+
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/capture-vision-exception.html)
188188

189189
**See Also**
190190

@@ -204,7 +204,7 @@ public void addResultFilter(CapturedResultFilter filter) throws CaptureVisionExc
204204

205205
**Exceptions**
206206

207-
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/capture-vision-exception.html)
207+
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/capture-vision-exception.html)
208208

209209
**See Also**
210210

@@ -254,11 +254,11 @@ Returns a `CaptureVisionError` object that contains error information.
254254

255255
**Exceptions**
256256

257-
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/capture-vision-exception.html)
257+
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/capture-vision-exception.html)
258258

259259
**See Also**
260260

261-
[CaptureVisionError]({{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/capture-vision-error.html)
261+
[CaptureVisionError]({{ site.dcvb_java_api }}capture-vision-router/capture-vision-error.html)
262262

263263
## stopCapturing
264264

‎programming/java/api-reference/capture-vision-router/settings.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ Returns a `CaptureVisionError` object that contains error information.
3939

4040
**Exceptions**
4141

42-
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/capture-vision-exception.html)
42+
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/capture-vision-exception.html)
4343

4444
**See Also**
4545

46-
[CaptureVisionError]({{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/capture-vision-error.html)
46+
[CaptureVisionError]({{ site.dcvb_java_api }}capture-vision-router/capture-vision-error.html)
4747

4848
## initSettingsFromFile
4949

@@ -63,11 +63,11 @@ Returns a `CaptureVisionError` object that contains error information.
6363

6464
**Exceptions**
6565

66-
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/capture-vision-exception.html)
66+
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/capture-vision-exception.html)
6767

6868
**See Also**
6969

70-
[CaptureVisionError]({{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/capture-vision-error.html)
70+
[CaptureVisionError]({{ site.dcvb_java_api }}capture-vision-router/capture-vision-error.html)
7171

7272
## outputSettings
7373

@@ -98,7 +98,7 @@ Returns a string containing the exported template.
9898

9999
**Exceptions**
100100

101-
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/capture-vision-exception.html)
101+
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/capture-vision-exception.html)
102102

103103
## outputSettingsToFile
104104

@@ -127,7 +127,7 @@ public void outputSettingsToFile(String templateName, String filePath, boolean i
127127

128128
**Exceptions**
129129

130-
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/capture-vision-exception.html)
130+
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/capture-vision-exception.html)
131131

132132
## getSimplifiedSettings
133133

@@ -154,7 +154,7 @@ Returns a `SimplifiedCaptureVisionSettings` object containing all settings.
154154

155155
**Exceptions**
156156

157-
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/capture-vision-exception.html)
157+
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/capture-vision-exception.html)
158158

159159
**See Also**
160160

@@ -183,7 +183,7 @@ public void updateSettings(String templateName, SimplifiedCaptureVisionSettings
183183

184184
**Exceptions**
185185

186-
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/capture-vision-exception.html)
186+
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/capture-vision-exception.html)
187187

188188
**See Also**
189189

@@ -199,7 +199,7 @@ public void resetSettings() throws CaptureVisionException
199199

200200
**Exceptions**
201201

202-
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/auxiliary-classes/capture-vision-exception.html)
202+
[`CaptureVisionException`]({{ site.dcvb_java_api }}capture-vision-router/capture-vision-exception.html)
203203

204204
## getParameterTemplateCount
205205

0 commit comments

Comments
 (0)