configured javadoc plugin to ignore generated classes and packages not meant to be used directely

Author: br-iosb

dataformat-uanodeset/pom.xml

@@ -149,6 +149,14 @@
 					</execution>
 				</executions>
 			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-javadoc-plugin</artifactId>
+				<configuration>
+					<!-- excluding generated classes and mappers which are not meant to be used directly -->
+					<excludePackageNames>com.kscs.util.*:org.opcfoundation.*:io.adminshell.aas.v3.dataformat.i4aas.mappers:io.adminshell.aas.v3.dataformat.i4aas.mappers.*</excludePackageNames>
+				</configuration>
+			</plugin>
 		</plugins>
 	</build>
 </project>

dataformat-uanodeset/src/main/java/io/adminshell/aas/v3/dataformat/i4aas/I4AASDeserializer.java

@@ -15,42 +15,22 @@
  */
 package io.adminshell.aas.v3.dataformat.i4aas;
 
-import java.util.List;
-
-import javax.xml.bind.JAXBException;
-
-import org.opcfoundation.ua._2011._03.uanodeset.UANode;
-import org.opcfoundation.ua._2011._03.uanodeset.UANodeSet;
-
 import io.adminshell.aas.v3.dataformat.DeserializationException;
 import io.adminshell.aas.v3.dataformat.Deserializer;
-import io.adminshell.aas.v3.dataformat.i4aas.parsers.EnvironmentParser;
-import io.adminshell.aas.v3.dataformat.i4aas.parsers.ParserContext;
-import io.adminshell.aas.v3.dataformat.i4aas.parsers.UANodeWrapper;
 import io.adminshell.aas.v3.model.AssetAdministrationShellEnvironment;
 
+/**
+ * Deserializer Implementation for I4AAS
+ *
+ */
 public class I4AASDeserializer implements Deserializer {
 
+	/**
+	 * reads a I4AAS as string and return the model object
+	 */
 	@Override
 	public AssetAdministrationShellEnvironment read(String value) throws DeserializationException {
-		try {
-			UANodeSet uaNodeSet = new UANodeSetUnmarshaller().unmarshall(value);
-			ParserContext parserContext = new ParserContext(uaNodeSet);
-			UANodeWrapper environment = parserContext.getPreparsedEnvironment();
-			return new EnvironmentParser(environment, new ParserContext(uaNodeSet)).parse();
-		} catch (JAXBException e) {
-			throw new DeserializationException("Deserialization failed due to a JAXBException.", e);
-		}
-	}
-
-	protected UANode findAASEnvironment(UANodeSet nodeSet) throws DeserializationException {
-		List<UANode> uaObjectOrUAVariableOrUAMethod = nodeSet.getUAObjectOrUAVariableOrUAMethod();
-		for (UANode uaNode : uaObjectOrUAVariableOrUAMethod) {
-			if (uaNode.getBrowseName().contains("AASEnvironment")) {
-				return uaNode;
-			}
-		}
-		throw new DeserializationException("No AASEnvironment found.");
+		throw new UnsupportedOperationException("Not Implemented yet.");
 	}
 
 	@Override

dataformat-uanodeset/src/main/java/io/adminshell/aas/v3/dataformat/i4aas/I4AASSerializer.java

@@ -25,8 +25,15 @@
 import io.adminshell.aas.v3.dataformat.i4aas.mappers.MappingContext;
 import io.adminshell.aas.v3.model.AssetAdministrationShellEnvironment;
 
+/**
+ * Serializer Implementation for I4AAS
+ *
+ */
 public class I4AASSerializer implements Serializer {
 
+	/**
+	 * takes a AAS model and returns a I4AAS as string.
+	 */
 	@Override
 	public String write(AssetAdministrationShellEnvironment aasEnvironment) throws SerializationException {
 		MappingContext mappingContext = new MappingContext(aasEnvironment);

dataformat-uanodeset/src/main/java/io/adminshell/aas/v3/dataformat/i4aas/UANodeSetMarshaller.java

@@ -25,14 +25,25 @@
 import org.opcfoundation.ua._2011._03.uanodeset.UANodeSet;
 import org.opcfoundation.ua.i4aas.v3.types.AASKeyDataType;
 
+/**
+ * Marshaller with predefined context and properties relevant for serialization.
+ *
+ */
 public class UANodeSetMarshaller {
 
 	private UANodeSet nodeset;
 
+	/**
+	 * @param nodeset the nodeset to be marshalled
+	 */
 	public UANodeSetMarshaller(UANodeSet nodeset) {
 		this.nodeset = nodeset;
 	}
 
+	/**
+	 * @return marshalled UANodeSet given in constructor
+	 * @throws JAXBException if action failed
+	 */
 	public String marshallAsString() throws JAXBException {
 		JAXBContext jaxbCtx = org.eclipse.persistence.jaxb.JAXBContextFactory.createContext(new Class[] {UANodeSet.class, ListOfExtensionObject.class, AASKeyDataType.class}, null);
 		Marshaller marshaller = jaxbCtx.createMarshaller();

dataformat-uanodeset/src/main/java/io/adminshell/aas/v3/dataformat/i4aas/UANodeSetUnmarshaller.java

@@ -28,21 +28,39 @@
 import org.opcfoundation.ua._2011._03.uanodeset.UANodeSet;
 import org.opcfoundation.ua.i4aas.v3.types.AASKeyDataType;
 
+
+/**
+ * Unmarshaller with predefined context and properties relevant for deserialization.
+ *
+ */
 public class UANodeSetUnmarshaller {
 
 	private JAXBContext jaxbCtx;
 	private Unmarshaller unmarshaller;
 
+	/**
+	 * @throws JAXBException if the internal creation of a context based unmarshaller failed
+	 */
 	public UANodeSetUnmarshaller() throws JAXBException {
 		jaxbCtx = org.eclipse.persistence.jaxb.JAXBContextFactory.createContext(
 				new Class[] { UANodeSet.class, ListOfExtensionObject.class, AASKeyDataType.class }, null);
 		unmarshaller = jaxbCtx.createUnmarshaller();
 	}
 
+	/**
+	 * @param input UANodeSet as XML string
+	 * @return unmarshalled UANodeSet
+	 * @throws JAXBException if action failed
+	 */
 	public UANodeSet unmarshall(String input) throws JAXBException {
 		return (UANodeSet) unmarshaller.unmarshal(new StringReader(input));
 	}
 
+	/**
+	 * @param input UANodeSet as XML inputstream
+	 * @return unmarshalled UANodeSet
+	 * @throws JAXBException if action failed
+	 */
 	public UANodeSet unmarshall(InputStream input) throws JAXBException {
 		return (UANodeSet) unmarshaller.unmarshal(input);
 	}

dataformat-uanodeset/src/main/java/io/adminshell/aas/v3/dataformat/i4aas/mappers/I4AASMapper.java

@@ -28,26 +28,45 @@
 import io.adminshell.aas.v3.dataformat.i4aas.mappers.utils.UaIdentifier;
 import io.adminshell.aas.v3.model.LangString;
 
+/**
+ * Generic base class used for all mapper implementation. 
+ *
+ * @param <SOURCE> mapping source
+ * @param <TARGET> mapping target
+ */
 public abstract class I4AASMapper<SOURCE, TARGET extends UANode> {
 
 	protected MappingContext ctx;
 	protected SOURCE source;
 	protected TARGET target;
 
+	/**
+	 * @param src
+	 * @param ctx
+	 */
 	public I4AASMapper(SOURCE src, MappingContext ctx) {
 		this.source = src;
 		this.ctx = ctx;
 	}
 
+	/**
+	 * @return the mapping complete target object with all children attached
+	 */
 	public final TARGET map() {
 		target = createTargetObject();
 		addToNodeset();
 		mapAndAttachChildren();
 		return target;
 	}
 
+	/**
+	 * @return return the object filled with attributes directly bound to the target.
+	 */
 	protected abstract TARGET createTargetObject();
 
+	/**
+	 *  action to be called when the children objects must be mapped and attached to the target.
+	 */
 	protected abstract void mapAndAttachChildren();
 
 	private void addToNodeset() {