Skip to content

Commit e81fb8d

Browse files
committed
Add menu headers
1 parent 31e6e13 commit e81fb8d

File tree

1 file changed

+27
-6
lines changed

1 file changed

+27
-6
lines changed

documentation/developer-guide/modules/tooling-guide/pages/error-codes.adoc

Lines changed: 27 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,27 @@
55

66
This reference describes all error codes and validation results that can be produced by the ESMF SDK when loading, parsing, or validating Aspect Models.
77

8+
== Table of Contents
9+
10+
* <<error-code-format,Error Code Format>>
11+
* <<error-categories,Error Categories>>
12+
* <<meta-violations,Meta-violations>>
13+
* <<shacl-violations,SHACL Constraint Violations>>
14+
** <<datatype-violations,Data Type Violations>>
15+
** <<cardinality-violations,Cardinality Violations>>
16+
** <<constraint-violations,Value Constraint Violations>>
17+
** <<structure-violations,Structure and Relationship Violations>>
18+
** <<enumeration-violations,Enumeration and Choice Violations>>
19+
** <<samm-specific-violations,SAMM-Specific Violations>>
20+
* <<error-contexts,Error Contexts>>
21+
* <<error-message-format,Error Message Format>>
22+
* <<accessing-error-information,Accessing Error Information>>
23+
* <<error-resolution,Error Resolution Guide>>
24+
* <<best-practices,Best Practices>>
25+
* <<integration-examples,Integration Examples>>
26+
* <<version-compatibility,Version Compatibility>>
27+
* <<troubleshooting,Troubleshooting>>
28+
829
[[error-code-format]]
930
== Error Code Format
1031

@@ -169,7 +190,7 @@ Context information:
169190
Element: :ElementName
170191
Property: :propertyName
171192
File: model.ttl:15:23
172-
193+
173194
Suggestion: Specific guidance for fixing the error.
174195
```
175196

@@ -262,11 +283,11 @@ Each error code includes specific guidance in the error message. Common patterns
262283
public class CustomViolationFormatter implements Violation.Visitor<String> {
263284
@Override
264285
public String visit(DatatypeViolation violation) {
265-
return String.format("ERR_TYPE: Fix data type for %s (Line %d)",
266-
violation.context().element(),
286+
return String.format("ERR_TYPE: Fix data type for %s (Line %d)",
287+
violation.context().element(),
267288
violation.context().sourceLocation().line());
268289
}
269-
290+
270291
// ... other visitor methods
271292
}
272293
----
@@ -277,7 +298,7 @@ public class CustomViolationFormatter implements Violation.Visitor<String> {
277298
----
278299
Map<String, List<Violation>> errorsByCode = violations.stream()
279300
.collect(Collectors.groupingBy(Violation::errorCode));
280-
301+
281302
// Handle each error type separately
282303
List<Violation> dataTypeErrors = errorsByCode.get("ERR_TYPE");
283304
List<Violation> cardinalityErrors = errorsByCode.get("ERR_MAX_COUNT");
@@ -340,4 +361,4 @@ For version-specific error code information, see the release notes and migration
340361
For additional support:
341362
- ESMF SDK GitHub Issues: https://github.com/eclipse-esmf/esmf-sdk/issues
342363
- SAMM Specification: https://eclipse-esmf.github.io/samm-specification/
343-
- Community Forum: https://github.com/eclipse-esmf/esmf-sdk/discussions
364+
- Community Forum: https://github.com/eclipse-esmf/esmf-sdk/discussions

0 commit comments

Comments
 (0)