Add missing JavaDoc

Author: atextor

core/esmf-aspect-model-validator/src/main/java/org/eclipse/esmf/aspectmodel/shacl/constraint/Constraint.java

@@ -20,21 +20,45 @@
 import org.eclipse.esmf.aspectmodel.shacl.violation.Violation;
 
 import org.apache.jena.rdf.model.RDFNode;
+
 /**
- * Represents a SHACL constraint component as a function that takes the <a href="https://www.w3.org/TR/shacl/#value-nodes">value node</a> as input
- * and returns a (possibly empty) list of violations.
- *
+ * Represents a SHACL constraint component as a function that takes the <a href="https://www.w3.org/TR/shacl/#value-nodes">value node</a> as
+ * input and returns a (possibly empty) list of violations.
+ * <br/>
  * Not implemented: sh:qualifiedValueShape, sh:qualifiedMinCount, sh:qualifiedMaxCount
  */
 public interface Constraint extends BiFunction<RDFNode, EvaluationContext, List<Violation>> {
+   /**
+    * Determines whether this constraint can be used on a node shape, as certain constraints (e.g., sh:minCount) can only be used on
+    * property shapes.
+    *
+    * @return the allowed value
+    */
    default boolean canBeUsedOnNodeShapes() {
       return true;
    }
 
+   /**
+    * The name of the constraint as given by sh:name
+    *
+    * @return the name
+    */
    String name();
 
+   /**
+    * Visitor pattern for Constraints: Accept the constraint visitor
+    *
+    * @param visitor the visitor
+    * @param <T> the visitor's result type
+    * @return the value corresponding to the visitor
+    */
    <T> T accept( Visitor<T> visitor );
 
+   /**
+    * The visitor interface for Constraints
+    *
+    * @param <T> the return type for the visitor
+    */
    interface Visitor<T> {
       T visit( Constraint constraint );
 

core/esmf-aspect-model-validator/src/main/java/org/eclipse/esmf/aspectmodel/shacl/constraint/js/JsBlankNode.java

@@ -15,6 +15,9 @@
 
 import org.apache.jena.graph.Node;
 
+/**
+ * Represents a <a href="https://www.w3.org/TR/shacl-js/#js-api-bnode">SHACL JS BlankNode</a>.
+ */
 public class JsBlankNode extends JsTerm {
    public final String id;
 

core/esmf-aspect-model-validator/src/main/java/org/eclipse/esmf/aspectmodel/shacl/constraint/js/JsFactory.java

@@ -16,6 +16,9 @@
 import org.apache.jena.graph.Node;
 import org.apache.jena.graph.Triple;
 
+/**
+ * Utility class that translates between SHACL JS objects and their RDF representation
+ */
 public class JsFactory {
    public static JsTerm asJsTerm( final Node node ) {
       if ( node.isURI() ) {

core/esmf-aspect-model-validator/src/main/java/org/eclipse/esmf/aspectmodel/shacl/constraint/js/JsLiteral.java

@@ -16,6 +16,9 @@
 import org.apache.jena.graph.Node;
 import org.apache.jena.graph.NodeFactory;
 
+/**
+ * Represents a <a href="https://www.w3.org/TR/shacl-js/#js-api-literals">SHACL JS Literal</a>
+ */
 public class JsLiteral extends JsTerm {
    public final String lex;
    public final String language;

core/esmf-aspect-model-validator/src/main/java/org/eclipse/esmf/aspectmodel/shacl/constraint/js/JsNamedNode.java

@@ -15,6 +15,9 @@
 
 import org.apache.jena.graph.Node;
 
+/**
+ * Represents a <a href="https://www.w3.org/TR/shacl-js/#js-api-iri">SHACL JS Named Node</a>
+ */
 public class JsNamedNode extends JsTerm {
    public final String uri;
 

core/esmf-aspect-model-validator/src/main/java/org/eclipse/esmf/aspectmodel/shacl/constraint/js/JsTriple.java

@@ -15,6 +15,9 @@
 
 import org.apache.jena.graph.Triple;
 
+/**
+ * Represents a <a href="https://www.w3.org/TR/shacl-js/#js-api-triples">SHACL JS Triple</a>
+ */
 public class JsTriple {
    private final Triple triple;
    public final JsTerm subject;

core/esmf-aspect-model-validator/src/main/java/org/eclipse/esmf/aspectmodel/shacl/fix/Fix.java

@@ -15,6 +15,9 @@
 
 import org.eclipse.esmf.aspectmodel.shacl.violation.EvaluationContext;
 
+/**
+ * A fix that can be applied to a violation to remove it
+ */
 public interface Fix {
    EvaluationContext context();
 

core/esmf-aspect-model-validator/src/main/java/org/eclipse/esmf/aspectmodel/shacl/violation/ClassTypeViolation.java

@@ -13,9 +13,21 @@
 
 package org.eclipse.esmf.aspectmodel.shacl.violation;
 
+import org.eclipse.esmf.aspectmodel.shacl.constraint.ClassConstraint;
+
 import org.apache.jena.rdf.model.Resource;
 
+/**
+ * Violation of a {@link ClassConstraint}
+ *
+ * @param context the evaluation context of this violation
+ * @param allowedClass the allowed class
+ * @param actualClass the actually encountered class
+ */
 public record ClassTypeViolation( EvaluationContext context, Resource allowedClass, Resource actualClass ) implements Violation {
+   /**
+    * The error code for this violation
+    */
    public static final String ERROR_CODE = "ERR_CLASS_TYPE";
 
    @Override

core/esmf-aspect-model-validator/src/main/java/org/eclipse/esmf/aspectmodel/shacl/violation/ClosedViolation.java

@@ -13,14 +13,27 @@
 
 package org.eclipse.esmf.aspectmodel.shacl.violation;
 
+import java.util.List;
 import java.util.Set;
 import java.util.stream.Collectors;
-import java.util.stream.Stream;
+
+import org.eclipse.esmf.aspectmodel.shacl.constraint.ClosedConstraint;
 
 import org.apache.jena.rdf.model.Property;
 
+/**
+ * Violation of a {@link ClosedConstraint}
+ *
+ * @param context the evaluation context of this violation
+ * @param allowedProperties the properties that are allowed on the value node
+ * @param ignoredProperties the properties that were ignored in the validation
+ * @param actual the actually encountered property
+ */
 public record ClosedViolation( EvaluationContext context, Set<Property> allowedProperties, Set<Property> ignoredProperties,
       Property actual ) implements Violation {
+   /**
+    * The error code for this violation
+    */
    public static final String ERROR_CODE = "ERR_CLOSED";
 
    @Override

core/esmf-aspect-model-validator/src/main/java/org/eclipse/esmf/aspectmodel/shacl/violation/DatatypeViolation.java

@@ -27,6 +27,13 @@
 import org.apache.jena.vocabulary.RDF;
 import org.apache.jena.vocabulary.XSD;
 
+/**
+ * Violation of a {@link DatatypeConstraint}
+ *
+ * @param context the evaluation context
+ * @param allowedTypeUri the URI of the XSD or RDF class type that was allowed
+ * @param actualTypeUri the URI that was encountered instead
+ */
 public record DatatypeViolation( EvaluationContext context, String allowedTypeUri, String actualTypeUri ) implements Violation {
    public static final String ERROR_CODE = "ERR_TYPE";