544621 - Mixed line endings (LF and CRLF) and other formatting issues
Formatted code with Eclipse 2019-3 [build-in] formatter
Signed-off-by: Matthias Koller <m.koller@peak-solution.de>
diff --git a/src/main/java/org/eclipse/mdm/api/dflt/ApplicationContext.java b/src/main/java/org/eclipse/mdm/api/dflt/ApplicationContext.java
index dbc436a..3cef93d 100644
--- a/src/main/java/org/eclipse/mdm/api/dflt/ApplicationContext.java
+++ b/src/main/java/org/eclipse/mdm/api/dflt/ApplicationContext.java
@@ -18,8 +18,8 @@
import org.eclipse.mdm.api.dflt.model.EntityFactory;
/**
- * Extends the {@link BaseApplicationContext} interface to return {@link EntityFactory}
- * and {@link EntityManager}.
+ * Extends the {@link BaseApplicationContext} interface to return
+ * {@link EntityFactory} and {@link EntityManager}.
*
* @since 1.0.0
*/
diff --git a/src/main/java/org/eclipse/mdm/api/dflt/EntityManager.java b/src/main/java/org/eclipse/mdm/api/dflt/EntityManager.java
index 6878e61..1f42019 100644
--- a/src/main/java/org/eclipse/mdm/api/dflt/EntityManager.java
+++ b/src/main/java/org/eclipse/mdm/api/dflt/EntityManager.java
@@ -41,20 +41,15 @@
// ======================================================================
/**
- * Loads the entity identified by given entity class, {@link ContextType}
- * and its instance ID.
+ * Loads the entity identified by given entity class, {@link ContextType} and
+ * its instance ID.
*
- * @param <T>
- * The desired type.
- * @param entityClass
- * Type of the returned entity.
- * @param contextType
- * The {@link ContextType}.
- * @param instanceID
- * The instance ID.
+ * @param <T> The desired type.
+ * @param entityClass Type of the returned entity.
+ * @param contextType The {@link ContextType}.
+ * @param instanceID The instance ID.
* @return The entity with given instance ID is returned.
- * @throws DataAccessException
- * Thrown if unable to retrieve the entity.
+ * @throws DataAccessException Thrown if unable to retrieve the entity.
*/
default <T extends Entity> T load(Class<T> entityClass, ContextType contextType, String instanceID)
throws DataAccessException {
@@ -63,12 +58,12 @@
throw new DataAccessException("Failed to load entity by instance ID.");
}
return entities.get(0);
-
+
}
<T extends Entity> List<T> load(Class<T> entityClass, ContextType contextType, Collection<String> instanceIDs)
throws DataAccessException;
-
+
/**
* Loads all available entities of given type.
*
@@ -79,15 +74,11 @@
* }
* </pre>
*
- * @param <T>
- * The desired type.
- * @param entityClass
- * Type of the returned entities.
- * @param contextType
- * The {@link ContextType}.
+ * @param <T> The desired type.
+ * @param entityClass Type of the returned entities.
+ * @param contextType The {@link ContextType}.
* @return Entities are returned in a {@code List}.
- * @throws DataAccessException
- * Thrown if unable to retrieve the entities.
+ * @throws DataAccessException Thrown if unable to retrieve the entities.
* @see #loadAll(Class, ContextType, String)
*/
default <T extends Entity> List<T> loadAll(Class<T> entityClass, ContextType contextType)
@@ -107,19 +98,14 @@
* }
* </pre>
*
- * @param <T>
- * The desired type.
- * @param entityClass
- * Type of the returned entities.
- * @param contextType
- * The {@link ContextType}.
- * @param pattern
- * Is always case sensitive and may contain wildcard characters
- * as follows: "?" for one matching character and "*" for a
- * sequence of matching characters.
+ * @param <T> The desired type.
+ * @param entityClass Type of the returned entities.
+ * @param contextType The {@link ContextType}.
+ * @param pattern Is always case sensitive and may contain wildcard
+ * characters as follows: "?" for one matching character and
+ * "*" for a sequence of matching characters.
* @return Matched entities are returned in a {@code List}.
- * @throws DataAccessException
- * Thrown if unable to retrieve the entities.
+ * @throws DataAccessException Thrown if unable to retrieve the entities.
* @see #loadAll(Class)
*/
<T extends Entity> List<T> loadAll(Class<T> entityClass, ContextType contextType, String pattern)
@@ -128,15 +114,11 @@
/**
* Loads the latest valid {@link Versionable} entity of given type and name.
*
- * @param <T>
- * The desired type.
- * @param entityClass
- * Type of the returned entity.
- * @param name
- * The exact name of the requested entity.
+ * @param <T> The desired type.
+ * @param entityClass Type of the returned entity.
+ * @param name The exact name of the requested entity.
* @return Optional is empty if no such entity was found
- * @throws DataAccessException
- * Thrown if unable to retrieve the entity.
+ * @throws DataAccessException Thrown if unable to retrieve the entity.
*/
default <T extends Versionable> Optional<T> loadLatestValid(Class<T> entityClass, String name)
throws DataAccessException {
@@ -148,17 +130,12 @@
* Loads the latest valid {@link Versionable} entity of given type,
* {@link ContextType} and name.
*
- * @param <T>
- * The desired type.
- * @param entityClass
- * Type of the returned entity.
- * @param contextType
- * The {@code ContextType}.
- * @param name
- * The exact name of the requested entity.
+ * @param <T> The desired type.
+ * @param entityClass Type of the returned entity.
+ * @param contextType The {@code ContextType}.
+ * @param name The exact name of the requested entity.
* @return Optional is empty if no such entity was found
- * @throws DataAccessException
- * Thrown if unable to retrieve the entity.
+ * @throws DataAccessException Thrown if unable to retrieve the entity.
*/
default <T extends Versionable> Optional<T> loadLatestValid(Class<T> entityClass, ContextType contextType,
String name) throws DataAccessException {
@@ -166,6 +143,5 @@
.filter(Versionable::isValid).max(Versionable.COMPARATOR);
}
-
<T extends StatusAttachable> List<T> loadAll(Class<T> entityClass, Status status, String pattern);
}
diff --git a/src/main/java/org/eclipse/mdm/api/dflt/model/CatalogAttribute.java b/src/main/java/org/eclipse/mdm/api/dflt/model/CatalogAttribute.java
index c891127..ece5816 100644
--- a/src/main/java/org/eclipse/mdm/api/dflt/model/CatalogAttribute.java
+++ b/src/main/java/org/eclipse/mdm/api/dflt/model/CatalogAttribute.java
@@ -95,8 +95,7 @@
/**
* Constructor.
*
- * @param core
- * The {@link Core}.
+ * @param core The {@link Core}.
*/
CatalogAttribute(Core core) {
super(core);
@@ -133,8 +132,7 @@
/**
* Sets a new value reference flag for this catalog attribute.
*
- * @param valueListReference
- * The new value list reference flag.
+ * @param valueListReference The new value list reference flag.
*/
public void setValueListReference(Boolean valueListReference) {
getValue(ATTR_VALUE_LIST_REFERENCE).set(valueListReference);
@@ -153,8 +151,7 @@
/**
* Sets a new value copyable flag for this catalog attribute.
*
- * @param valueCopyable
- * The new value copyable flag.
+ * @param valueCopyable The new value copyable flag.
*/
public void setValueCopyable(Boolean valueCopyable) {
getValue(ATTR_VALUE_COPYABLE).set(valueCopyable);
@@ -172,8 +169,7 @@
/**
* Sets a new action request class name for this attribute.
*
- * @param actionRequestClassname
- * The new action request class name.
+ * @param actionRequestClassname The new action request class name.
*/
public void setActionRequestClassname(String actionRequestClassname) {
getValue(ATTR_ACTION_REQUEST_CLASSNAME).set(actionRequestClassname);
@@ -191,8 +187,7 @@
/**
* Replaces current {@link ValueList} relation with the given one.
*
- * @param valueList
- * The new {@code ValueList} may be null.
+ * @param valueList The new {@code ValueList} may be null.
*/
public void setValueList(ValueList valueList) {
if (valueList == null) {
@@ -217,8 +212,8 @@
/**
* Returns the parent {@link CatalogSensor}.
*
- * @return {@code Optional} is empty if a {@link CatalogComponent} is parent
- * of this catalog attribute.
+ * @return {@code Optional} is empty if a {@link CatalogComponent} is parent of
+ * this catalog attribute.
* @see #getCatalogComponent()
*/
public Optional<CatalogSensor> getCatalogSensor() {
@@ -242,10 +237,10 @@
* attribute.
*
* @return The enumeration class is returned.
- * @throws IllegalStateException
- * Thrown if this catalog attribute's {@link ValueType} returns
- * {@code true} when {@link ValueType#isEnumerationType()} is
- * called.
+ * @throws IllegalStateException Thrown if this catalog attribute's
+ * {@link ValueType} returns {@code true} when
+ * {@link ValueType#isEnumerationType()} is
+ * called.
*/
@SuppressWarnings("rawtypes")
public Enumeration getEnumerationObject() {
@@ -267,8 +262,7 @@
/**
* Sets a new {@link Unit} for this catalog attribute.
*
- * @param unit
- * The new {@code Unit} may be null.
+ * @param unit The new {@code Unit} may be null.
*/
public void setUnit(Unit unit) {
this.unit = unit;
@@ -306,8 +300,7 @@
/**
* Sets {@link ValueType} of this catalog attribute.
*
- * @param valueType
- * The {@link ValueType}.
+ * @param valueType The {@link ValueType}.
*/
void setValueType(ValueType<?> valueType) {
Enumeration<?> scalarTypeEnum = EnumRegistry.getInstance().get(EnumRegistry.SCALAR_TYPE);
@@ -318,12 +311,11 @@
/**
* Sets enumeration Object of this catalog attribute.
*
- * @param enumerationObj
- * The enumeration.
+ * @param enumerationObj The enumeration.
*/
void setEnumerationObj(Enumeration<?> enumerationObj) {
setValueType(ValueType.ENUMERATION);
- this.enumerationObj=enumerationObj;
+ this.enumerationObj = enumerationObj;
}
}
diff --git a/src/main/java/org/eclipse/mdm/api/dflt/model/CatalogComponent.java b/src/main/java/org/eclipse/mdm/api/dflt/model/CatalogComponent.java
index 1c0050f..ad835c8 100644
--- a/src/main/java/org/eclipse/mdm/api/dflt/model/CatalogComponent.java
+++ b/src/main/java/org/eclipse/mdm/api/dflt/model/CatalogComponent.java
@@ -58,8 +58,7 @@
/**
* Constructor.
*
- * @param core
- * The {@link Core}.
+ * @param core The {@link Core}.
*/
CatalogComponent(Core core) {
super(core);
@@ -91,8 +90,7 @@
/**
* Returns the {@link CatalogAttribute} identified by given name.
*
- * @param name
- * The name of the {@code CatalogAttribute}.
+ * @param name The name of the {@code CatalogAttribute}.
* @return The {@code Optional} is empty if a {@code CatalogAttribute} with
* given name does not exist.
*/
@@ -113,10 +111,9 @@
/**
* Removes the {@link CatalogAttribute} identified by given name.
*
- * @param name
- * Name of the {@code CatalogAttribute} that has to be removed.
- * @return Returns {@code true} if the {@code CatalogAttribute} with given
- * name has been removed.
+ * @param name Name of the {@code CatalogAttribute} that has to be removed.
+ * @return Returns {@code true} if the {@code CatalogAttribute} with given name
+ * has been removed.
*/
public boolean removeCatalogAttribute(String name) {
Optional<CatalogAttribute> catalogAttribute = getCatalogAttribute(name);
@@ -131,10 +128,9 @@
/**
* Returns the {@link CatalogSensor} identified by given name.
*
- * @param name
- * The name of the {@code CatalogSensor}.
- * @return The {@code Optional} is empty if a {@code CatalogSensor} with
- * given name does not exist.
+ * @param name The name of the {@code CatalogSensor}.
+ * @return The {@code Optional} is empty if a {@code CatalogSensor} with given
+ * name does not exist.
*/
public Optional<CatalogSensor> getCatalogSensor(String name) {
return getCatalogSensors().stream().filter(cs -> cs.nameEquals(name)).findAny();
@@ -157,10 +153,9 @@
/**
* Removes the {@link CatalogSensor} identified by given name.
*
- * @param name
- * Name of the {@code CatalogSensor} that has to be removed.
- * @return Returns {@code true} if the {@code CatalogSensor} with given name
- * has been removed.
+ * @param name Name of the {@code CatalogSensor} that has to be removed.
+ * @return Returns {@code true} if the {@code CatalogSensor} with given name has
+ * been removed.
*/
public boolean removeCatalogSensor(String name) {
Optional<CatalogSensor> catalogSensor = getCatalogSensor(name);
diff --git a/src/main/java/org/eclipse/mdm/api/dflt/model/CatalogSensor.java b/src/main/java/org/eclipse/mdm/api/dflt/model/CatalogSensor.java
index e377902..8c8654a 100644
--- a/src/main/java/org/eclipse/mdm/api/dflt/model/CatalogSensor.java
+++ b/src/main/java/org/eclipse/mdm/api/dflt/model/CatalogSensor.java
@@ -50,8 +50,7 @@
/**
* Constructor.
*
- * @param core
- * The {@link Core}.
+ * @param core The {@link Core}.
*/
CatalogSensor(Core core) {
super(core);
@@ -73,8 +72,7 @@
/**
* Returns the {@link CatalogAttribute} identified by given name.
*
- * @param name
- * The name of the {@code CatalogAttribute}.
+ * @param name The name of the {@code CatalogAttribute}.
* @return The {@code Optional} is empty if a {@code CatalogAttribute} with
* given name does not exist.
*/
@@ -95,10 +93,9 @@
/**
* Removes the {@link CatalogAttribute} identified by given name.
*
- * @param name
- * Name of the {@code CatalogAttribute} that has to be removed.
- * @return Returns {@code true} if the {@code CatalogAttribute} with given
- * name has been removed.
+ * @param name Name of the {@code CatalogAttribute} that has to be removed.
+ * @return Returns {@code true} if the {@code CatalogAttribute} with given name
+ * has been removed.
*/
public boolean removeCatalogAttribute(String name) {
Optional<CatalogAttribute> catalogAttribute = getCatalogAttribute(name);
diff --git a/src/main/java/org/eclipse/mdm/api/dflt/model/Classification.java b/src/main/java/org/eclipse/mdm/api/dflt/model/Classification.java
index 43981b4..702d134 100644
--- a/src/main/java/org/eclipse/mdm/api/dflt/model/Classification.java
+++ b/src/main/java/org/eclipse/mdm/api/dflt/model/Classification.java
@@ -19,44 +19,38 @@
import org.eclipse.mdm.api.base.model.BaseEntity;
import org.eclipse.mdm.api.base.model.StatusAttachable;
-public class Classification
- extends BaseEntity {
+public class Classification extends BaseEntity {
- // ======================================================================
- // Constructors
- // ======================================================================
+ // ======================================================================
+ // Constructors
+ // ======================================================================
- /**
- * Constructor.
- *
- * @param core
- * The {@link Core}.
- */
- Classification(Core core) {
- super(core);
- }
+ /**
+ * Constructor.
+ *
+ * @param core The {@link Core}.
+ */
+ Classification(Core core) {
+ super(core);
+ }
- /**
- * Assigns this status to given {@link StatusAttachable}s.
- *
- * @param <T>
- * The status attachable type.
- * @param statusAttachables
- * This status will be assigned to all of them.
- */
- public <T extends StatusAttachable> void assign(List<T> statusAttachables) {
- statusAttachables.forEach(this::assign);
- }
+ /**
+ * Assigns this status to given {@link StatusAttachable}s.
+ *
+ * @param <T> The status attachable type.
+ * @param statusAttachables This status will be assigned to all of them.
+ */
+ public <T extends StatusAttachable> void assign(List<T> statusAttachables) {
+ statusAttachables.forEach(this::assign);
+ }
- /**
- * Assigns this status to given {@link StatusAttachable}.
- *
- * @param <T>
- * The status attachable type.
- * @param statusAttachable
- * This status will be assigned to it.
- */
- public <T extends StatusAttachable> void assign(T statusAttachable) {
- getCore(statusAttachable).getMutableStore().set(this);
- }
+ /**
+ * Assigns this status to given {@link StatusAttachable}.
+ *
+ * @param <T> The status attachable type.
+ * @param statusAttachable This status will be assigned to it.
+ */
+ public <T extends StatusAttachable> void assign(T statusAttachable) {
+ getCore(statusAttachable).getMutableStore().set(this);
+ }
}
diff --git a/src/main/java/org/eclipse/mdm/api/dflt/model/Domain.java b/src/main/java/org/eclipse/mdm/api/dflt/model/Domain.java
index 5c6833f..095f388 100644
--- a/src/main/java/org/eclipse/mdm/api/dflt/model/Domain.java
+++ b/src/main/java/org/eclipse/mdm/api/dflt/model/Domain.java
@@ -19,17 +19,16 @@
public class Domain extends BaseEntity implements Describable {
- // ======================================================================
- // Constructors
- // ======================================================================
+ // ======================================================================
+ // Constructors
+ // ======================================================================
- /**
- * Constructor.
- *
- * @param core
- * The {@link Core}.
- */
- Domain(Core core) {
- super(core);
- }
+ /**
+ * Constructor.
+ *
+ * @param core The {@link Core}.
+ */
+ Domain(Core core) {
+ super(core);
+ }
}
diff --git a/src/main/java/org/eclipse/mdm/api/dflt/model/EntityFactory.java b/src/main/java/org/eclipse/mdm/api/dflt/model/EntityFactory.java
index 5e07cf1..f67d546 100644
--- a/src/main/java/org/eclipse/mdm/api/dflt/model/EntityFactory.java
+++ b/src/main/java/org/eclipse/mdm/api/dflt/model/EntityFactory.java
@@ -57,8 +57,7 @@
/**
* Creates a new {@link Role}.
*
- * @param name
- * Name of the created {@code Role}.
+ * @param name Name of the created {@code Role}.
* @return The created {@code Role} is returned.
*/
public Role createRole(String name) {
@@ -69,13 +68,12 @@
return role;
}
-
+
/**
- * Always throws an UnsupportedOperationException since in a default model
- * each {@link Test} has a parent {@link Pool}.
+ * Always throws an UnsupportedOperationException since in a default model each
+ * {@link Test} has a parent {@link Pool}.
*
- * @throws UnsupportedOperationException
- * Is always thrown.
+ * @throws UnsupportedOperationException Is always thrown.
*/
@Override
public Test createTest(String name) {
@@ -85,8 +83,7 @@
/**
* Creates a new {@link Project}.
*
- * @param name
- * Name of the created {@code Project}.
+ * @param name Name of the created {@code Project}.
* @return The created {@code Project} is returned.
*/
public Project createProject(String name) {
@@ -101,10 +98,8 @@
/**
* Creates a new {@link Pool} for given {@link Project}.
*
- * @param name
- * Name of the created {@code Pool}.
- * @param project
- * The parent {@code Project}.
+ * @param name Name of the created {@code Pool}.
+ * @param project The parent {@code Project}.
* @return The created {@code Pool} is returned.
*/
public Pool createPool(String name, Project project) {
@@ -123,26 +118,22 @@
/**
* Creates a new {@link Test} for given {@link Pool}.
*
- * @param name
- * Name of the created {@code Test}.
- * @param pool
- * The parent {@code Pool}.
+ * @param name Name of the created {@code Test}.
+ * @param pool The parent {@code Pool}.
* @return The created {@code Test} is returned.
*/
public Test createTest(String name, Pool pool) {
return createTest(name, pool, (Status) null);
}
-
+
/**
* Creates a new {@link Test} for given {@link Pool} using given
* {@link TemplateTest}.
*
- * @param name
- * Name of the created {@code Test}.
- * @param pool
- * The parent {@code Pool}.
- * @param templateTest
- * The template the returned {@code Test} will be derived from.
+ * @param name Name of the created {@code Test}.
+ * @param pool The parent {@code Pool}.
+ * @param templateTest The template the returned {@code Test} will be derived
+ * from.
* @return The created {@code Test} is returned.
*/
// TODO make a decision: status in or out!
@@ -154,11 +145,9 @@
* Creates a new {@link ContextRoot} for given {@link TestStep} using given
* {@link TemplateRoot}.
*
- * @param testStep
- * The parent {@code TestStep}.
- * @param templateRoot
- * The template the returned {@code ContextRoot} will be derived
- * from.
+ * @param testStep The parent {@code TestStep}.
+ * @param templateRoot The template the returned {@code ContextRoot} will be
+ * derived from.
* @return The created {@code ContextRoot} is returned.
*/
public ContextRoot createContextRoot(TestStep testStep, TemplateRoot templateRoot) {
@@ -171,39 +160,34 @@
}
/**
- * Creates a new {@link ContextRoot} for given {@link Measurement} using
- * given {@link TemplateRoot}.
+ * Creates a new {@link ContextRoot} for given {@link Measurement} using given
+ * {@link TemplateRoot}.
*
- * @param measurement
- * The parent {@code Measurement}.
- * @param templateRoot
- * The template the returned {@code ContextRoot} will be derived
- * from.
+ * @param measurement The parent {@code Measurement}.
+ * @param templateRoot The template the returned {@code ContextRoot} will be
+ * derived from.
* @return The created {@code ContextRoot} is returned.
*/
public ContextRoot createContextRoot(Measurement measurement, TemplateRoot templateRoot) {
return createContextRoot(Arrays.asList(measurement), templateRoot);
}
-
+
/**
- * Creates a new {@link ContextRoot} for given {@link List} if {@link Measurement}s using
- * given {@link TemplateRoot}. If List is null or empty context root is created with no
- * relations.
+ * Creates a new {@link ContextRoot} for given {@link List} if
+ * {@link Measurement}s using given {@link TemplateRoot}. If List is null or
+ * empty context root is created with no relations.
*
- * @param measurements
- * The parent {@code Measurement}.
- * @param templateRoot
- * The template the returned {@code ContextRoot} will be derived
- * from.
+ * @param measurements The parent {@code Measurement}.
+ * @param templateRoot The template the returned {@code ContextRoot} will be
+ * derived from.
* @return The created {@code ContextRoot} is returned.
*/
public ContextRoot createContextRoot(List<Measurement> measurements, TemplateRoot templateRoot) {
ContextRoot contextRoot = createContextRoot(templateRoot);
// relations
- if(measurements != null && !measurements.isEmpty()) {
- measurements.forEach(m ->
- getCore(m).getMutableStore().set(contextRoot, templateRoot.getContextType()));
+ if (measurements != null && !measurements.isEmpty()) {
+ measurements.forEach(m -> getCore(m).getMutableStore().set(contextRoot, templateRoot.getContextType()));
}
return contextRoot;
@@ -212,9 +196,8 @@
/**
* Creates a new {@link ContextRoot} using given {@link TemplateRoot}.
*
- * @param templateRoot
- * The template the returned {@code ContextRoot} will be derived
- * from.
+ * @param templateRoot The template the returned {@code ContextRoot} will be
+ * derived from.
* @return The created {@code ContextRoot} is returned.
*/
public ContextRoot createContextRoot(TemplateRoot templateRoot) {
@@ -234,9 +217,9 @@
}
/**
- * @throws IllegalArgumentException
- * Thrown if given name is already in use or
- * {@link TemplateComponent} with given name does not exist.
+ * @throws IllegalArgumentException Thrown if given name is already in use or
+ * {@link TemplateComponent} with given name
+ * does not exist.
*/
@Override
public ContextComponent createContextComponent(String name, ContextRoot contextRoot) {
@@ -316,7 +299,7 @@
templateSensor.get().getTemplateAttributes().forEach(ta -> {
contextSensor.getValue(ta.getName()).set(ta.getDefaultValue().extract());
});
-
+
return contextSensor;
}
@@ -327,13 +310,10 @@
* Creates a new {@link CatalogComponent} with given {@link ContextType} and
* name.
*
- * @param contextType
- * The {@code ContextType}.
- * @param name
- * Name of the created {@code CatalogComponent}.
+ * @param contextType The {@code ContextType}.
+ * @param name Name of the created {@code CatalogComponent}.
* @return The created {@code CatalogComponent} is returned.
- * @throws IllegalArgumentException
- * Thrown if name is not allowed.
+ * @throws IllegalArgumentException Thrown if name is not allowed.
*/
public CatalogComponent createCatalogComponent(ContextType contextType, String name) {
validateCatalogName(name, false);
@@ -349,9 +329,8 @@
}
/**
- * Creates a new {@link CatalogAttribute} for given
- * {@link CatalogComponent}. The {@link ValueType} may be one of the
- * following:
+ * Creates a new {@link CatalogAttribute} for given {@link CatalogComponent}.
+ * The {@link ValueType} may be one of the following:
*
* <ul>
* <li>{@link ValueType#STRING}</li>
@@ -383,16 +362,13 @@
* </ul>
*
*
- * @param name
- * Name of the created {@code CatalogAttribute}.
- * @param valueType
- * The {@code ValueType}.
- * @param catalogComponent
- * The parent {@code CatalogComponent}.
+ * @param name Name of the created {@code CatalogAttribute}.
+ * @param valueType The {@code ValueType}.
+ * @param catalogComponent The parent {@code CatalogComponent}.
* @return The created {@code CatalogAttribute} is returned.
- * @throws IllegalArgumentException
- * Thrown if given name is already in use or not allowed or
- * given {@code ValueType} is not supported.
+ * @throws IllegalArgumentException Thrown if given name is already in use or
+ * not allowed or given {@code ValueType} is
+ * not supported.
*/
public CatalogAttribute createCatalogAttribute(String name, ValueType<?> valueType,
CatalogComponent catalogComponent) {
@@ -421,19 +397,15 @@
}
/**
- * Creates a new {@link CatalogAttribute} for given
- * {@link CatalogComponent}.
+ * Creates a new {@link CatalogAttribute} for given {@link CatalogComponent}.
*
- * @param name
- * Name of the created {@code CatalogAttribute}.
- * @param enumerationObject
- * The enumeration.
- * @param catalogComponent
- * The parent {@code CatalogComponent}.
+ * @param name Name of the created {@code CatalogAttribute}.
+ * @param enumerationObject The enumeration.
+ * @param catalogComponent The parent {@code CatalogComponent}.
* @return The created {@code CatalogAttribute} is returned.
- * @throws IllegalArgumentException
- * Thrown if given name is already in use or not allowed or
- * given enumeration class is not supported.
+ * @throws IllegalArgumentException Thrown if given name is already in use or
+ * not allowed or given enumeration class is
+ * not supported.
*/
public CatalogAttribute createCatalogAttribute(String name, Enumeration<?> enumerationObj,
CatalogComponent catalogComponent) {
@@ -457,22 +429,19 @@
return catalogAttribute;
}
-
+
/**
* Creates a new {@link CatalogAttribute} for given {@link CatalogSensor}. The
* {@link ValueType} may be one of the following like in
* {@link #createCatalogAttribute(String, ValueType, CatalogComponent)}:
*
- * @param name
- * Name of the created {@code CatalogAttribute}.
- * @param valueType
- * The {@code ValueType}.
- * @param catalogSensor
- * The parent {@code CatalogSensor}.
+ * @param name Name of the created {@code CatalogAttribute}.
+ * @param valueType The {@code ValueType}.
+ * @param catalogSensor The parent {@code CatalogSensor}.
* @return The created {@code CatalogAttribute} is returned.
- * @throws IllegalArgumentException
- * Thrown if given name is already in use or not allowed or given
- * {@code ValueType} is not supported.
+ * @throws IllegalArgumentException Thrown if given name is already in use or
+ * not allowed or given {@code ValueType} is
+ * not supported.
*/
public CatalogAttribute createCatalogSensorAttribute(String name, ValueType<?> valueType,
CatalogSensor catalogSensor) {
@@ -485,8 +454,7 @@
throw new IllegalArgumentException("Value type '" + valueType + "' is not allowed.");
}
- CatalogAttribute catalogAttribute = new CatalogAttribute(
- createCore(CatalogAttribute.class));
+ CatalogAttribute catalogAttribute = new CatalogAttribute(createCore(CatalogAttribute.class));
// relations
getCore(catalogAttribute).getPermanentStore().set(catalogSensor);
@@ -503,15 +471,12 @@
/**
* Creates a new {@link CatalogSensor} for given {@link CatalogComponent}.
*
- * @param name
- * Name of the created {@code CatalogSensor}.
- * @param enumerationObject
- * The enumeration.
- * @param catalogComponent
- * The parent {@code CatalogComponent}.
+ * @param name Name of the created {@code CatalogSensor}.
+ * @param enumerationObject The enumeration.
+ * @param catalogComponent The parent {@code CatalogComponent}.
* @return The created {@code CatalogSensor} is returned.
- * @throws IllegalArgumentException
- * Thrown if given name is already in use or not allowed
+ * @throws IllegalArgumentException Thrown if given name is already in use or
+ * not allowed
*/
public CatalogSensor createCatalogSensor(String name, CatalogComponent catalogComponent) {
validateCatalogName(name, false);
@@ -536,13 +501,10 @@
}
/**
- * Creates a new {@link TemplateRoot} with given {@link ContextType} and
- * name.
+ * Creates a new {@link TemplateRoot} with given {@link ContextType} and name.
*
- * @param contextType
- * The {@code ContextType}.
- * @param name
- * Name of the created {@code TemplateRoot}.
+ * @param contextType The {@code ContextType}.
+ * @param name Name of the created {@code TemplateRoot}.
* @return The created {@code TemplateRoot} is returned.
*/
public TemplateRoot createTemplateRoot(ContextType contextType, String name) {
@@ -558,20 +520,16 @@
}
/**
- * Creates a new {@link TemplateComponent} for given {@link TemplateRoot}
- * using given {@link CatalogComponent}.
+ * Creates a new {@link TemplateComponent} for given {@link TemplateRoot} using
+ * given {@link CatalogComponent}.
*
- * @param name
- * Name of the created {@code TemplateComponent}.
- * @param templateRoot
- * The parent {@code TemplateRoot}.
- * @param catalogComponent
- * The associated {@link CatalogComponent}.
+ * @param name Name of the created {@code TemplateComponent}.
+ * @param templateRoot The parent {@code TemplateRoot}.
+ * @param catalogComponent The associated {@link CatalogComponent}.
* @return The created {@code TemplateComponent} is returned.
- * @throws IllegalArgumentException
- * Thrown if {@code ContextType} of {@code
- * TemplateRoot} and {@code CatalogComponent} do not match or given
- * name is already in use.
+ * @throws IllegalArgumentException Thrown if {@code ContextType} of {@code
+ * TemplateRoot} and {@code CatalogComponent} do not match or
+ * given name is already in use.
*/
public TemplateComponent createTemplateComponent(String name, TemplateRoot templateRoot,
CatalogComponent catalogComponent) {
@@ -603,20 +561,17 @@
}
/**
- * Creates a new {@link TemplateComponent} for given
- * {@link TemplateComponent} using given {@link CatalogComponent}.
+ * Creates a new {@link TemplateComponent} for given {@link TemplateComponent}
+ * using given {@link CatalogComponent}.
*
- * @param name
- * Name of the created {@code TemplateComponent}.
- * @param partentComponentTemplate
- * The parent {@code TemplateComponent}.
- * @param catalogComponent
- * The associated {@link CatalogComponent}.
+ * @param name Name of the created
+ * {@code TemplateComponent}.
+ * @param partentComponentTemplate The parent {@code TemplateComponent}.
+ * @param catalogComponent The associated {@link CatalogComponent}.
* @return The created {@code TemplateComponent} is returned.
- * @throws IllegalArgumentException
- * Thrown if {@code ContextType} of {@code
- * TemplateComponent} and {@code CatalogComponent} do not match or
- * given name is already in use.
+ * @throws IllegalArgumentException Thrown if {@code ContextType} of {@code
+ * TemplateComponent} and {@code CatalogComponent} do not match or
+ * given name is already in use.
*/
public TemplateComponent createTemplateComponent(String name, TemplateComponent partentComponentTemplate,
CatalogComponent catalogComponent) {
@@ -649,16 +604,12 @@
}
/**
- * Creates a new {@link TemplateAttribute} for given
- * {@link TemplateComponent}.
+ * Creates a new {@link TemplateAttribute} for given {@link TemplateComponent}.
*
- * @param name
- * Name of the created {@code TemplateAttribute}.
- * @param templateComponent
- * The parent {@code TemplateComponent}.
+ * @param name Name of the created {@code TemplateAttribute}.
+ * @param templateComponent The parent {@code TemplateComponent}.
* @return The created {@code TemplateAttribute} is returned.
- * @throws IllegalArgumentException
- * Thrown if given name is already in use.
+ * @throws IllegalArgumentException Thrown if given name is already in use.
*/
public TemplateAttribute createTemplateAttribute(String name, TemplateComponent templateComponent) {
if (templateComponent.getTemplateAttribute(name).isPresent()) {
@@ -691,22 +642,16 @@
* Creates a new {@link TemplateSensor} for given {@link TemplateComponent}
* based on the given {@link CatalogSensor}.
*
- * @param name
- * Name of the created {@code TemplateAttribute}.
- * @param templateComponent
- * The parent {@code TemplateComponent}.
- * @param catalogSensor
- * reference CatalogSensor
- * @param quantity
- * Quantity to create {@link TemplateSensor} for
+ * @param name Name of the created {@code TemplateAttribute}.
+ * @param templateComponent The parent {@code TemplateComponent}.
+ * @param catalogSensor reference CatalogSensor
+ * @param quantity Quantity to create {@link TemplateSensor} for
* @return The created {@code TemplateSensor} is returned.
- * @throws IllegalArgumentException
- * Thrown if given name is already in use.
+ * @throws IllegalArgumentException Thrown if given name is already in use.
*/
public TemplateSensor createTemplateSensor(String name, TemplateComponent templateComponent,
CatalogSensor catalogSensor, Quantity quantity) {
- if (templateComponent.getTemplateSensor(name)
- .isPresent()) {
+ if (templateComponent.getTemplateSensor(name).isPresent()) {
throw new IllegalArgumentException("Template sensor with name '" + name + "' already exists.");
}
@@ -720,8 +665,7 @@
tplAttr.setOptional(Boolean.TRUE);
getPermanentStore(tplAttr).set(templateSensor);
getMutableStore(tplAttr).set(catAttr);
- getCore(templateSensor).getChildrenStore()
- .add(tplAttr);
+ getCore(templateSensor).getChildrenStore().add(tplAttr);
}
// relations
@@ -744,8 +688,7 @@
/**
* Creates a new {@link TemplateTestStep}.
*
- * @param name
- * Name of the created {@code TemplateTestStep}.
+ * @param name Name of the created {@code TemplateTestStep}.
* @return The created {@code TemplateTestStep} is returned.
*/
public TemplateTestStep createTemplateTestStep(String name) {
@@ -763,8 +706,7 @@
/**
* Creates a new {@link TemplateTest}.
*
- * @param name
- * Name of the created {@code TemplateTest}.
+ * @param name Name of the created {@code TemplateTest}.
* @return The created {@code TemplateTest} is returned.
*/
public TemplateTest createTemplateTest(String name) {
@@ -780,15 +722,12 @@
}
/**
- * Creates a new {@link TemplateTestStepUsage} for given
- * {@link TemplateTest} using given {@link TemplateTestStep}.
+ * Creates a new {@link TemplateTestStepUsage} for given {@link TemplateTest}
+ * using given {@link TemplateTestStep}.
*
- * @param name
- * Name of the created {@code TemplateTestStepUsage}.
- * @param templateTest
- * The parent {@link TemplateTest}.
- * @param templateTestStep
- * The related {@link TemplateTestStep}.
+ * @param name Name of the created {@code TemplateTestStepUsage}.
+ * @param templateTest The parent {@link TemplateTest}.
+ * @param templateTestStep The related {@link TemplateTestStep}.
* @return The created {@code TemplateTestStepUsage} is returned.
*/
public TemplateTestStepUsage createTemplateTestStepUsage(String name, TemplateTest templateTest,
@@ -817,8 +756,7 @@
/**
* Creates a new {@link ValueList}.
*
- * @param name
- * Name of the created {@code ValueList}.
+ * @param name Name of the created {@code ValueList}.
* @return The created {@code ValueList} is returned.
*/
public ValueList createValueList(String name) {
@@ -834,10 +772,8 @@
/**
* Creates a new {@link ValueListValue} for given {@link ValueList}.
*
- * @param name
- * Name of the created {@code ValueListValue}.
- * @param valueList
- * The parent {@code ValueList}.
+ * @param name Name of the created {@code ValueListValue}.
+ * @param valueList The parent {@code ValueList}.
* @return The created {@code ValueListValue} is returned.
*/
public ValueListValue createValueListValue(String name, ValueList valueList) {
@@ -898,18 +834,14 @@
* Creates a new {@link Test} for given {@link Pool} using given
* {@link TemplateTest}.
*
- * @param name
- * Name of the created {@code Test}.
- * @param pool
- * The parent {@code Pool}.
- * @param statusTest
- * The related {@link Status} of the created {@code
- * Test}.
- * @param statusTestStep
- * The related {@link Status} of the created {@code
- * TestStep}.
- * @param templateTest
- * The template the returned {@code Test} will be derived from.
+ * @param name Name of the created {@code Test}.
+ * @param pool The parent {@code Pool}.
+ * @param statusTest The related {@link Status} of the created {@code
+ * Test} .
+ * @param statusTestStep The related {@link Status} of the created {@code
+ * TestStep} .
+ * @param templateTest The template the returned {@code Test} will be derived
+ * from.
* @return The created {@code Test} is returned.
*/
// TODO make a decision: status in or out!
@@ -933,12 +865,9 @@
/**
* Creates a new {@link Test} for given {@link Pool}.
*
- * @param name
- * Name of the created {@code Test}.
- * @param pool
- * The parent {@code Pool}.
- * @param status
- * The related {@link Status}.
+ * @param name Name of the created {@code Test}.
+ * @param pool The parent {@code Pool}.
+ * @param status The related {@link Status}.
* @return The created {@code Test} is returned.
*/
// TODO make a decision: status in or out!
@@ -960,11 +889,9 @@
* Creates a new {@link TestStep} for given {@link Test} using given
* {@link TemplateTestStep}.
*
- * @param test
- * The parent {@code Test}.
- * @param templateTestStep
- * The template the returned {@code TestStep} will be derived
- * from.
+ * @param test The parent {@code Test}.
+ * @param templateTestStep The template the returned {@code TestStep} will be
+ * derived from.
* @return The created {@code TestStep} is returned.
*/
public TestStep createTestStep(Test test, TemplateTestStep templateTestStep) {
@@ -975,13 +902,10 @@
* Creates a new {@link TestStep} for given {@link Test} using given
* {@link TemplateTestStep}.
*
- * @param test
- * The parent {@code Test}.
- * @param status
- * The related {@link Status}.
- * @param templateTestStep
- * The template the returned {@code TestStep} will be derived
- * from.
+ * @param test The parent {@code Test}.
+ * @param status The related {@link Status}.
+ * @param templateTestStep The template the returned {@code TestStep} will be
+ * derived from.
* @return The created {@code TestStep} is returned.
*/
// TODO make a decision: status in or out!
@@ -1006,12 +930,9 @@
/**
* Creates a new {@link TestStep} for given {@link Test}.
*
- * @param name
- * Name of the created {@code Test}.
- * @param test
- * The parent {@code Test}.
- * @param status
- * The related {@link Status}.
+ * @param name Name of the created {@code Test}.
+ * @param test The parent {@code Test}.
+ * @param status The related {@link Status}.
* @return The created {@code TestStep} is returned.
*/
// TODO make a decision: status in or out!
@@ -1024,7 +945,7 @@
return testStep;
}
-
+
/**
* {@inheritDoc}
*/
@@ -1043,13 +964,11 @@
}
/**
- * Checks whether given enumeration is defined in the application
- * model or not.
+ * Checks whether given enumeration is defined in the application model or not.
*
- * @param enumerationObj
- * The checked enumeration class.
- * @throws IllegalArgumentException
- * Thrown if given enumeration class is not supported.
+ * @param enumerationObj The checked enumeration class.
+ * @throws IllegalArgumentException Thrown if given enumeration class is not
+ * supported.
*/
protected abstract void validateEnum(Enumeration<?> enumerationObj);
@@ -1060,12 +979,10 @@
/**
* Checks whether given catalog name is allowed or not.
*
- * @param name
- * The checked name.
- * @param isAttributeName
- * Flag indicates whether given name is for a catalog attribute.
- * @throws IllegalArgumentException
- * Thrown if given name is not allowed.
+ * @param name The checked name.
+ * @param isAttributeName Flag indicates whether given name is for a catalog
+ * attribute.
+ * @throws IllegalArgumentException Thrown if given name is not allowed.
*/
private static void validateCatalogName(String name, boolean isAttributeName) {
if (!isValidCatalogName(name)) {
@@ -1081,12 +998,11 @@
"A catalog attribute name is not allowed to be " + "'id', 'name' or 'mimetype' (case ignored).");
}
}
-
+
/**
* Checks whether given catalog name is valid
*
- * @param name
- * The checked name.
+ * @param name The checked name.
* @return Returns {@code true} if name is a valid catalog name
*/
private static boolean isValidCatalogName(String name) {
@@ -1096,10 +1012,8 @@
/**
* Hides {@link Value} containers missing in the templates.
*
- * @param contextCore
- * The {@link ContextComponent} {@link Core}.
- * @param templateAttributes
- * The {@link TemplateAttribute}s of the template.
+ * @param contextCore The {@link ContextComponent} {@link Core}.
+ * @param templateAttributes The {@link TemplateAttribute}s of the template.
*/
private static void hideValues(Core contextCore, List<TemplateAttribute> templateAttributes) {
Set<String> names = new HashSet<>(contextCore.getValues().keySet());
diff --git a/src/main/java/org/eclipse/mdm/api/dflt/model/Pool.java b/src/main/java/org/eclipse/mdm/api/dflt/model/Pool.java
index 6b97d16..4f767c7 100644
--- a/src/main/java/org/eclipse/mdm/api/dflt/model/Pool.java
+++ b/src/main/java/org/eclipse/mdm/api/dflt/model/Pool.java
@@ -52,8 +52,7 @@
/**
* Constructor.
*
- * @param core
- * The {@link Core}.
+ * @param core The {@link Core}.
*/
Pool(Core core) {
super(core);
diff --git a/src/main/java/org/eclipse/mdm/api/dflt/model/Project.java b/src/main/java/org/eclipse/mdm/api/dflt/model/Project.java
index 4639928..738e975 100644
--- a/src/main/java/org/eclipse/mdm/api/dflt/model/Project.java
+++ b/src/main/java/org/eclipse/mdm/api/dflt/model/Project.java
@@ -44,8 +44,7 @@
/**
* Constructor.
*
- * @param core
- * The {@link Core}.
+ * @param core The {@link Core}.
*/
Project(Core core) {
super(core);
diff --git a/src/main/java/org/eclipse/mdm/api/dflt/model/ProjectDomain.java b/src/main/java/org/eclipse/mdm/api/dflt/model/ProjectDomain.java
index 0f8f6cb..b1f0f5a 100644
--- a/src/main/java/org/eclipse/mdm/api/dflt/model/ProjectDomain.java
+++ b/src/main/java/org/eclipse/mdm/api/dflt/model/ProjectDomain.java
@@ -20,16 +20,16 @@
public class ProjectDomain extends BaseEntity implements Describable {
- // ======================================================================
- // Constructors
- // ======================================================================
+ // ======================================================================
+ // Constructors
+ // ======================================================================
- /**
- * Constructor.
- *
- * @param core The {@link Core}.
- */
- ProjectDomain(Core core) {
- super(core);
- }
+ /**
+ * Constructor.
+ *
+ * @param core The {@link Core}.
+ */
+ ProjectDomain(Core core) {
+ super(core);
+ }
}
diff --git a/src/main/java/org/eclipse/mdm/api/dflt/model/Role.java b/src/main/java/org/eclipse/mdm/api/dflt/model/Role.java
index c15a9a1..76a58f6 100644
--- a/src/main/java/org/eclipse/mdm/api/dflt/model/Role.java
+++ b/src/main/java/org/eclipse/mdm/api/dflt/model/Role.java
@@ -21,8 +21,8 @@
import org.eclipse.mdm.api.base.model.User;
/**
- * Implementation of the role entity type. Each role can contain multiple {@link User}
- * and each {@link User} can be assigned multiple {@link Role}s.
+ * Implementation of the role entity type. Each role can contain multiple
+ * {@link User} and each {@link User} can be assigned multiple {@link Role}s.
*/
public class Role extends BaseEntity implements Deletable, Describable {
@@ -32,8 +32,7 @@
/**
* Constructor.
*
- * @param core
- * The {@link Core}.
+ * @param core The {@link Core}.
*/
Role(Core core) {
super(core);
@@ -47,7 +46,6 @@
getCore().getNtoMStore().add(REL_GROUPS2USERS, user);
}
-
/**
* @param user {@link User} to remove
*/
diff --git a/src/main/java/org/eclipse/mdm/api/dflt/model/Status.java b/src/main/java/org/eclipse/mdm/api/dflt/model/Status.java
index 2e28414..387c482 100644
--- a/src/main/java/org/eclipse/mdm/api/dflt/model/Status.java
+++ b/src/main/java/org/eclipse/mdm/api/dflt/model/Status.java
@@ -41,8 +41,7 @@
/**
* Constructor.
*
- * @param core
- * The {@link Core}.
+ * @param core The {@link Core}.
*/
Status(Core core) {
super(core);
@@ -55,10 +54,8 @@
/**
* Assigns this status to given {@link StatusAttachable}s.
*
- * @param <T>
- * The status attachable type.
- * @param statusAttachables
- * This status will be assigned to all of them.
+ * @param <T> The status attachable type.
+ * @param statusAttachables This status will be assigned to all of them.
*/
public <T extends StatusAttachable> void assign(List<T> statusAttachables) {
statusAttachables.forEach(this::assign);
@@ -67,10 +64,8 @@
/**
* Assigns this status to given {@link StatusAttachable}.
*
- * @param <T>
- * The status attachable type.
- * @param statusAttachable
- * This status will be assigned to it.
+ * @param <T> The status attachable type.
+ * @param statusAttachable This status will be assigned to it.
*/
public <T extends StatusAttachable> void assign(T statusAttachable) {
getCore(statusAttachable).getMutableStore().set(this);
@@ -79,13 +74,12 @@
/**
* Returns the {@link Status} attached to given {@link StatusAttachable}.
*
- * @param statusAttachable
- * The {@code StatusAttachable}.
+ * @param statusAttachable The {@code StatusAttachable}.
* @return Optional is empty if no {@code Status} is attached.
*/
public static Optional<Status> of(StatusAttachable statusAttachable) {
Classification classification = getCore(statusAttachable).getMutableStore().get(Classification.class);
- if ( classification == null ) {
+ if (classification == null) {
return Optional.empty();
}
return Optional.ofNullable(getCore(classification).getMutableStore().get(Status.class));
diff --git a/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateAttribute.java b/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateAttribute.java
index 3232954..9e01085 100644
--- a/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateAttribute.java
+++ b/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateAttribute.java
@@ -61,8 +61,8 @@
// ======================================================================
/**
- * This {@code Comparator} compares {@link TemplateAttribute}s by the sort
- * index of their corresponding {@link CatalogAttribute} in ascending order.
+ * This {@code Comparator} compares {@link TemplateAttribute}s by the sort index
+ * of their corresponding {@link CatalogAttribute} in ascending order.
*/
public static final Comparator<TemplateAttribute> COMPARATOR = Comparator
.comparing(ta -> ta.getCatalogAttribute().getSortIndex());
@@ -105,8 +105,7 @@
/**
* Constructor.
*
- * @param core
- * The {@link Core}.
+ * @param core The {@link Core}.
*/
TemplateAttribute(Core core) {
super(core);
@@ -140,8 +139,7 @@
* Sets a new default value for this template attribute. Given input will be
* stored in its {@link String} representation.
*
- * @param input
- * The new default value.
+ * @param input The new default value.
*/
public void setDefaultValue(Object input) {
if (input == null) {
@@ -177,8 +175,8 @@
/**
* Returns the value read only flag of this template attribute.
*
- * @return Returns {@code true} if it is not allowed to modify
- * {@link Value}s derived from this template attribute.
+ * @return Returns {@code true} if it is not allowed to modify {@link Value}s
+ * derived from this template attribute.
*/
public Boolean isValueReadOnly() {
return getValue(ATTR_VALUE_READONLY).extract();
@@ -187,8 +185,7 @@
/**
* Sets a new value read only flag for this template attribute.
*
- * @param valueReadOnly
- * The new value read only flag.
+ * @param valueReadOnly The new value read only flag.
*/
public void setValueReadOnly(Boolean valueReadOnly) {
getValue(ATTR_VALUE_READONLY).set(valueReadOnly);
@@ -197,8 +194,8 @@
/**
* Returns the optional flag of this template attribute.
*
- * @return Returns {@code true} if it is allowed to omit a {@link Value}
- * derived from this template attribute.
+ * @return Returns {@code true} if it is allowed to omit a {@link Value} derived
+ * from this template attribute.
*/
public Boolean isOptional() {
boolean mandatory = getValue(ATTR_OPTIONAL).extract();
@@ -208,16 +205,15 @@
/**
* Sets a new optional flag for this template attribute.
*
- * @param optional
- * The new optional flag.
+ * @param optional The new optional flag.
*/
public void setOptional(Boolean optional) {
getValue(ATTR_OPTIONAL).set(optional ? Boolean.FALSE : Boolean.TRUE);
}
/**
- * Returns the {@link CatalogAttribute} this template attribute is
- * associated with.
+ * Returns the {@link CatalogAttribute} this template attribute is associated
+ * with.
*
* @return The associated {@code CatalogAttribute} is returned.
*/
@@ -245,8 +241,8 @@
/**
* Returns the parent {@link TemplateComponent} of this template attribute.
*
- * @return {@code Optional} is empty if a {@link TemplateSensor} is parent
- * of this template attribute.
+ * @return {@code Optional} is empty if a {@link TemplateSensor} is parent of
+ * this template attribute.
* @see #getTemplateSensor()
*/
public Optional<TemplateComponent> getTemplateComponent() {
@@ -256,8 +252,8 @@
/**
* Returns the parent {@link TemplateSensor} of this template attribute.
*
- * @return {@code Optional} is empty if a {@link TemplateComponent} is
- * parent of this template attribute.
+ * @return {@code Optional} is empty if a {@link TemplateComponent} is parent of
+ * this template attribute.
* @see #getTemplateComponent()
*/
public Optional<TemplateSensor> getTemplateSensor() {
@@ -272,10 +268,8 @@
* Parses given {@code String} to the corresponding type of given
* {@link ValueType}.
*
- * @param value
- * The {@code String} value.
- * @param valueType
- * Used to resolve the corresponding converter.
+ * @param value The {@code String} value.
+ * @param valueType Used to resolve the corresponding converter.
* @return The parsed object is returned.
*/
private static Object parse(String value, ValueType<?> valueType) {
@@ -308,14 +302,12 @@
}
/**
- * Returns the {@code String} conversion function for given
- * {@link ValueType}.
+ * Returns the {@code String} conversion function for given {@link ValueType}.
*
- * @param valueType
- * Used as identifier.
+ * @param valueType Used as identifier.
* @return The {@code String} conversion {@code Function} is returned.
- * @throws IllegalArgumentException
- * Thrown if a corresponding {@code String} is not supported.
+ * @throws IllegalArgumentException Thrown if a corresponding {@code String} is
+ * not supported.
*/
private static Function<String, Object> getParser(ValueType<?> valueType) {
Function<String, Object> converter = VALUETYPE_FUNCTION_MAP.get(valueType);
@@ -358,8 +350,7 @@
/**
* Parses given {@code String} and returns it as {@link FileLink}.
*
- * @param value
- * The {@code String} value which will be parsed.
+ * @param value The {@code String} value which will be parsed.
* @return The corresponding {@code FileLink} is returned.
*/
public static FileLink parse(String value) {
@@ -389,10 +380,8 @@
/**
* Get string value for FileLinkType
*
- * @param value
- * The {@code Value} value.
- * @param sequence
- * The {@code boolean} sequence.
+ * @param value The {@code Value} value.
+ * @param sequence The {@code boolean} sequence.
* @return Return {@code String} string value for FileLinkType
*/
private String getStringValueForFileLinkType(Value value, boolean sequence) {
diff --git a/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateComponent.java b/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateComponent.java
index bac79c3..c447720 100644
--- a/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateComponent.java
+++ b/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateComponent.java
@@ -108,8 +108,7 @@
/**
* Constructor.
*
- * @param core
- * The {@link Core}.
+ * @param core The {@link Core}.
*/
TemplateComponent(Core core) {
super(core);
@@ -132,8 +131,7 @@
/**
* Sets a new optional flag for this template component.
*
- * @param optional
- * The new optional flag.
+ * @param optional The new optional flag.
*/
public void setOptional(Boolean optional) {
getValue(ATTR_OPTIONAL).set(optional);
@@ -142,10 +140,9 @@
/**
* Returns the default active flag of this template component.
*
- * @return Returns {@code true} if a {@link ContextComponent} has to be
- * created automatically each time a new {@link ContextRoot} is
- * derived from the {@link TemplateRoot} this template component
- * belongs to.
+ * @return Returns {@code true} if a {@link ContextComponent} has to be created
+ * automatically each time a new {@link ContextRoot} is derived from the
+ * {@link TemplateRoot} this template component belongs to.
*/
public Boolean isDefaultActive() {
return getValue(ATTR_DEFAULT_ACTIVE).extract();
@@ -154,8 +151,7 @@
/**
* Sets a new default active flag for this template component.
*
- * @param defaultActive
- * The new default active flag.
+ * @param defaultActive The new default active flag.
*/
public void setDefaultActive(Boolean defaultActive) {
getValue(ATTR_DEFAULT_ACTIVE).set(defaultActive);
@@ -164,9 +160,8 @@
/**
* Returns the series constant flag of this template component.
*
- * @return Returns {@code true} if the {@link ContextComponent}'s
- * {@link Value}s across {@link TestStep} siblings contain the same
- * values.
+ * @return Returns {@code true} if the {@link ContextComponent}'s {@link Value}s
+ * across {@link TestStep} siblings contain the same values.
*/
public Boolean isSeriesConstant() {
return getValue(ATTR_SERIES_CONSTANT).extract();
@@ -175,16 +170,15 @@
/**
* Sets a new series constant flag for this template component.
*
- * @param seriesConstant
- * The new series constant flag.
+ * @param seriesConstant The new series constant flag.
*/
public void setSeriesConstant(Boolean seriesConstant) {
getValue(ATTR_SERIES_CONSTANT).set(seriesConstant);
}
/**
- * Returns the {@link CatalogComponent} this template component is
- * associated with.
+ * Returns the {@link CatalogComponent} this template component is associated
+ * with.
*
* @return The associated {@code CatalogComponent} is returned.
*/
@@ -210,8 +204,8 @@
/**
* Returns the parent {@link TemplateComponent} of this template component.
*
- * @return {@code Optional} is empty if this template component is an
- * immediate child of the {@link TemplateRoot}.
+ * @return {@code Optional} is empty if this template component is an immediate
+ * child of the {@link TemplateRoot}.
* @see #getTemplateRoot()
*/
public Optional<TemplateComponent> getParentTemplateComponent() {
@@ -221,8 +215,7 @@
/**
* Returns the {@link TemplateAttribute} identified by given name.
*
- * @param name
- * The name of the {@code TemplateAttribute}.
+ * @param name The name of the {@code TemplateAttribute}.
* @return The {@code Optional} is empty if a {@code TemplateAttribute} with
* given name does not exist.
*/
@@ -243,10 +236,9 @@
/**
* Removes the {@link TemplateAttribute} identified by given name.
*
- * @param name
- * Name of the {@code TemplateAttribute} that has to be removed.
- * @return Returns {@code true} if the {@code TemplateAttribute} with given
- * name has been removed.
+ * @param name Name of the {@code TemplateAttribute} that has to be removed.
+ * @return Returns {@code true} if the {@code TemplateAttribute} with given name
+ * has been removed.
*/
public boolean removeTemplateAttribute(String name) {
Optional<TemplateAttribute> templateAttribute = getTemplateAttribute(name);
@@ -264,15 +256,14 @@
* <p>
* <b>NOTE:</b> The names of <u>all</u> template components belonging to the
* same {@link TemplateRoot} must have unique names (no matter they are
- * immediate children or not). Therefore, if this template component does
- * not have an immediate template component with the given name, this lookup
- * request is recursively delegated to all of its child template components.
+ * immediate children or not). Therefore, if this template component does not
+ * have an immediate template component with the given name, this lookup request
+ * is recursively delegated to all of its child template components.
*
- * @param name
- * The name of the {@code TemplateComponent}.
+ * @param name The name of the {@code TemplateComponent}.
* @return The {@code Optional} is empty if a {@code TemplateComponent} with
- * given name does not exist (neither this template component nor
- * one of its children has a template component with given name).
+ * given name does not exist (neither this template component nor one of
+ * its children has a template component with given name).
*/
public Optional<TemplateComponent> getTemplateComponent(String name) {
List<TemplateComponent> templateComponents = getTemplateComponents();
@@ -302,14 +293,13 @@
* <p>
* <b>NOTE:</b> The names of <u>all</u> template components belonging to the
* same {@link TemplateRoot} must have unique names (no matter they are
- * immediate children or not). Therefore, if this template component does
- * not have an immediate template component with the given name, this remove
- * request is recursively delegated to all of its child template components.
+ * immediate children or not). Therefore, if this template component does not
+ * have an immediate template component with the given name, this remove request
+ * is recursively delegated to all of its child template components.
*
- * @param name
- * Name of the {@code TemplateComponent} that has to be removed.
- * @return Returns {@code true} if the {@code TemplateComponent} with given
- * name has been removed.
+ * @param name Name of the {@code TemplateComponent} that has to be removed.
+ * @return Returns {@code true} if the {@code TemplateComponent} with given name
+ * has been removed.
*/
public boolean removeTemplateComponent(String name) {
Optional<TemplateComponent> templateComponent = getTemplateComponent(name);
@@ -329,10 +319,9 @@
/**
* Returns the {@link TemplateSensor} identified by given name.
*
- * @param name
- * The name of the {@code TemplateSensor}.
- * @return The {@code Optional} is empty if a {@code TemplateSensor} with
- * given name does not exist.
+ * @param name The name of the {@code TemplateSensor}.
+ * @return The {@code Optional} is empty if a {@code TemplateSensor} with given
+ * name does not exist.
*/
public Optional<TemplateSensor> getTemplateSensor(String name) {
return getTemplateSensors().stream().filter(ts -> ts.nameEquals(name)).findAny();
@@ -355,10 +344,9 @@
/**
* Removes the {@link TemplateSensor} identified by given name.
*
- * @param name
- * Name of the {@code TemplateSensor} that has to be removed.
- * @return Returns {@code true} if the {@code TemplateSensor} with given
- * name has been removed.
+ * @param name Name of the {@code TemplateSensor} that has to be removed.
+ * @return Returns {@code true} if the {@code TemplateSensor} with given name
+ * has been removed.
*/
public boolean removeTemplateSensor(String name) {
Optional<TemplateSensor> templateSensor = getTemplateSensor(name);
@@ -397,14 +385,13 @@
}
/**
- * Returns the {@link TemplateComponent} the given {@link ContextComponent}
- * is derived from.
+ * Returns the {@link TemplateComponent} the given {@link ContextComponent} is
+ * derived from.
*
- * @param contextComponent
- * The {@code ContextComponent} whose {@code
+ * @param contextComponent The {@code ContextComponent} whose {@code
* TemplateComponent} is requested.
- * @return {@code Optional} is empty if the given {@code ContextComponent}
- * is not derived from a template, which is data source specific.
+ * @return {@code Optional} is empty if the given {@code ContextComponent} is
+ * not derived from a template, which is data source specific.
*/
public static Optional<TemplateComponent> of(ContextComponent contextComponent) {
return Optional.ofNullable(getCore(contextComponent).getMutableStore().get(TemplateComponent.class));
diff --git a/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateRoot.java b/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateRoot.java
index a5b85b0..0bb6560 100644
--- a/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateRoot.java
+++ b/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateRoot.java
@@ -60,8 +60,7 @@
/**
* Constructor.
*
- * @param core
- * The {@link Core}.
+ * @param core The {@link Core}.
*/
TemplateRoot(Core core) {
super(core);
@@ -94,15 +93,13 @@
* Returns the {@link TemplateComponent} identified by given name.
*
* <p>
- * <b>NOTE:</b> The names of <u>all</u> {@code TemplateComponent}s belonging
- * to the same template root must have unique names (no matter they are
- * immediate children or not). Therefore, if this template root does not
- * have an immediate {@code TemplateComponent} with the given name, this
- * lookup request is recursively delegated to all of its child
- * {@code TemplateComponent}s.
+ * <b>NOTE:</b> The names of <u>all</u> {@code TemplateComponent}s belonging to
+ * the same template root must have unique names (no matter they are immediate
+ * children or not). Therefore, if this template root does not have an immediate
+ * {@code TemplateComponent} with the given name, this lookup request is
+ * recursively delegated to all of its child {@code TemplateComponent}s.
*
- * @param name
- * The name of the {@code TemplateComponent}.
+ * @param name The name of the {@code TemplateComponent}.
* @return The {@code Optional} is empty if a {@code TemplateComponent} with
* given name does not exist at all within this template root.
*/
@@ -132,17 +129,15 @@
* Removes the {@link TemplateComponent} identified by given name.
*
* <p>
- * <b>NOTE:</b> The names of <u>all</u> {@code TemplateComponent}s belonging
- * to the same template roots must have unique names (no matter they are
- * immediate children or not). Therefore, if this template root does not
- * have an immediate {@code TemplateComponent} with the given name, this
- * remove request is recursively delegated to all of its child
- * {@code TemplateComponent}s.
+ * <b>NOTE:</b> The names of <u>all</u> {@code TemplateComponent}s belonging to
+ * the same template roots must have unique names (no matter they are immediate
+ * children or not). Therefore, if this template root does not have an immediate
+ * {@code TemplateComponent} with the given name, this remove request is
+ * recursively delegated to all of its child {@code TemplateComponent}s.
*
- * @param name
- * Name of the {@code TemplateComponent} that has to be removed.
- * @return Returns {@code true} if the {@code TemplateComponent} with given
- * name has been removed.
+ * @param name Name of the {@code TemplateComponent} that has to be removed.
+ * @return Returns {@code true} if the {@code TemplateComponent} with given name
+ * has been removed.
*/
public boolean removeTemplateComponent(String name) {
Optional<TemplateComponent> templateComponent = getTemplateComponent(name);
@@ -180,9 +175,8 @@
* Returns the {@link TemplateRoot} the given {@link ContextRoot} is derived
* from.
*
- * @param contextRoot
- * The {@code ContextRoot} whose {@code TemplateRoot} is
- * requested.
+ * @param contextRoot The {@code ContextRoot} whose {@code TemplateRoot} is
+ * requested.
* @return {@code Optional} is empty if the given {@code ContextRoot} is not
* derived from a template, which is data source specific.
*/
diff --git a/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateSensor.java b/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateSensor.java
index 09013e0..17c2bc6 100644
--- a/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateSensor.java
+++ b/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateSensor.java
@@ -110,8 +110,7 @@
/**
* Constructor.
*
- * @param core
- * The {@link Core}.
+ * @param core The {@link Core}.
*/
TemplateSensor(Core core) {
super(core);
@@ -133,8 +132,7 @@
/**
* Sets a new measured values editable flag for this template sensor.
*
- * @param measuredValuesEditable
- * The measured values editable flag.
+ * @param measuredValuesEditable The measured values editable flag.
*/
public void setMeasuredValuesEditable(Boolean measuredValuesEditable) {
getValue(ATTR_MEASRED_VALUES_EDITABLE).set(measuredValuesEditable);
@@ -152,8 +150,7 @@
/**
* Sets a new measured values generator name for this template sensor.
*
- * @param measuredValuesGeneratorName
- * The measured values generator name.
+ * @param measuredValuesGeneratorName The measured values generator name.
*/
public void setMeasuredValuesGeneratorName(String measuredValuesGeneratorName) {
getValue(ATTR_MEASRED_VALUES_GENERATOR_NAME).set(measuredValuesGeneratorName);
@@ -171,8 +168,7 @@
/**
* Sets a new measured values independent flag for this template sensor.
*
- * @param measuredValuesIndependent
- * The measured values independent flag.
+ * @param measuredValuesIndependent The measured values independent flag.
*/
public void setMeasuredValuesIndependent(Boolean measuredValuesIndependent) {
getValue(ATTR_MEASRED_VALUES_INDEPENDENT).set(measuredValuesIndependent);
@@ -190,8 +186,7 @@
/**
* Sets a new measured values {@link AxisType} for this template sensor.
*
- * @param axisType
- * The measured values {@code AxisType}.
+ * @param axisType The measured values {@code AxisType}.
*/
public void setMeasuredValuesAxisType(AxisType axisType) {
getValue(ATTR_MEASRED_VALUES_AXISTYPE).set(axisType);
@@ -200,8 +195,8 @@
/**
* Returns the optional flag of this template sensor.
*
- * @return Returns {@code true} if it is allowed to omit a
- * {@link ContextSensor} derived from this template sensor.
+ * @return Returns {@code true} if it is allowed to omit a {@link ContextSensor}
+ * derived from this template sensor.
*/
public Boolean isOptional() {
return getValue(ATTR_OPTIONAL).extract();
@@ -210,8 +205,7 @@
/**
* Sets a new optional flag for this template sensor.
*
- * @param optional
- * The new optional flag.
+ * @param optional The new optional flag.
*/
public void setOptional(Boolean optional) {
getValue(ATTR_OPTIONAL).set(optional);
@@ -222,8 +216,7 @@
*
* @return Returns {@code true} if a {@link ContextSensor} has to be created
* automatically each time a new {@link ContextComponent} is derived
- * from the {@link TemplateComponent} this template sensor belongs
- * to.
+ * from the {@link TemplateComponent} this template sensor belongs to.
*/
public Boolean isDefaultActive() {
return getValue(ATTR_DEFAULT_ACTIVE).extract();
@@ -232,16 +225,14 @@
/**
* Sets a new default active flag for this template sensor.
*
- * @param defaultActive
- * The new default active flag.
+ * @param defaultActive The new default active flag.
*/
public void setDefaultActive(Boolean defaultActive) {
getValue(ATTR_DEFAULT_ACTIVE).set(defaultActive);
}
/**
- * Returns the {@link CatalogSensor} this template sensor is associated
- * with.
+ * Returns the {@link CatalogSensor} this template sensor is associated with.
*
* @return The associated {@code CatalogSensor} is returned.
*/
@@ -279,8 +270,7 @@
/**
* Returns the {@link TemplateAttribute} identified by given name.
*
- * @param name
- * The name of the {@code TemplateAttribute}.
+ * @param name The name of the {@code TemplateAttribute}.
* @return The {@code Optional} is empty if a {@code TemplateAttribute} with
* given name does not exist.
*/
@@ -301,10 +291,9 @@
/**
* Removes the {@link TemplateAttribute} identified by given name.
*
- * @param name
- * Name of the {@code TemplateAttribute} that has to be removed.
- * @return Returns {@code true} if the {@code TemplateAttribute} with given
- * name has been removed.
+ * @param name Name of the {@code TemplateAttribute} that has to be removed.
+ * @return Returns {@code true} if the {@code TemplateAttribute} with given name
+ * has been removed.
*/
public boolean removeTemplateAttribute(String name) {
Optional<TemplateAttribute> templateAttribute = getTemplateAttribute(name);
@@ -333,14 +322,13 @@
}
/**
- * Returns the {@link TemplateSensor} the given {@link ContextSensor} is
- * derived from.
+ * Returns the {@link TemplateSensor} the given {@link ContextSensor} is derived
+ * from.
*
- * @param contextSensor
- * The {@code ContextSensor} whose {@code
+ * @param contextSensor The {@code ContextSensor} whose {@code
* TemplateSensor} is requested.
- * @return {@code Optional} is empty if the given {@code ContextSensor} is
- * not derived from a template, which is data source specific.
+ * @return {@code Optional} is empty if the given {@code ContextSensor} is not
+ * derived from a template, which is data source specific.
*/
public static Optional<TemplateSensor> of(ContextSensor contextSensor) {
return Optional.ofNullable(getCore(contextSensor).getMutableStore().get(TemplateSensor.class));
diff --git a/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateTest.java b/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateTest.java
index d54d717..acdb4f7 100644
--- a/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateTest.java
+++ b/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateTest.java
@@ -72,8 +72,7 @@
/**
* Constructor.
*
- * @param core
- * The {@link Core}.
+ * @param core The {@link Core}.
*/
TemplateTest(Core core) {
super(core);
@@ -95,8 +94,7 @@
/**
* Sets a new name helper class name for this template test.
*
- * @param nameHelperClassname
- * The new name helper class name.
+ * @param nameHelperClassname The new name helper class name.
*/
public void setNameHelperClassname(String nameHelperClassname) {
getValue(ATTR_NAMEHELPER_CLASSNAME).set(nameHelperClassname);
@@ -114,8 +112,7 @@
/**
* Sets new data source plug-in class names for this template test.
*
- * @param dataSourcePluginClassnames
- * The new data source plug-in class names.
+ * @param dataSourcePluginClassnames The new data source plug-in class names.
*/
public void setDataSourceClassnames(String[] dataSourcePluginClassnames) {
getValue(ATTR_DATASOURCE_PLUGIN_CLASSNAMES).set(dataSourcePluginClassnames);
@@ -133,8 +130,7 @@
/**
* Sets new test order action class names for this template test.
*
- * @param testOrderActionClassnames
- * The new test order action class names.
+ * @param testOrderActionClassnames The new test order action class names.
*/
public void setTestOrderActionClassnames(String[] testOrderActionClassnames) {
getValue(ATTR_TEST_ORDER_ACTION_CLASSNAMES).set(testOrderActionClassnames);
@@ -143,18 +139,17 @@
/**
* Returns the {@link TemplateTestStepUsage} identified by given name.
*
- * @param name
- * The name of the {@code TemplateTestStepUsage}.
- * @return The {@code Optional} is empty if a {@code TemplateTestStepUsage}
- * with given name does not exist.
+ * @param name The name of the {@code TemplateTestStepUsage}.
+ * @return The {@code Optional} is empty if a {@code TemplateTestStepUsage} with
+ * given name does not exist.
*/
public Optional<TemplateTestStepUsage> getTemplateTestStepUsage(String name) {
return getTemplateTestStepUsages().stream().filter(ttsu -> ttsu.nameEquals(name)).findAny();
}
/**
- * Returns all available {@link TemplateTestStepUsage}s related to this
- * template test.
+ * Returns all available {@link TemplateTestStepUsage}s related to this template
+ * test.
*
* @return The returned {@code List} is unmodifiable.
*/
@@ -165,11 +160,9 @@
/**
* Removes the {@link TemplateTestStepUsage} identified by given name.
*
- * @param name
- * Name of the {@code TemplateTestStepUsage} that has to be
- * removed.
- * @return Returns {@code true} if the {@code TemplateTestStepUsage} with
- * given name has been removed.
+ * @param name Name of the {@code TemplateTestStepUsage} that has to be removed.
+ * @return Returns {@code true} if the {@code TemplateTestStepUsage} with given
+ * name has been removed.
*/
public boolean removeTemplateTestStepUsage(String name) {
Optional<TemplateTestStepUsage> templateTestStepUsage = getTemplateTestStepUsage(name);
@@ -198,14 +191,13 @@
}
/**
- * Returns the {@link TemplateComponent} the given {@link ContextComponent}
- * is derived from.
+ * Returns the {@link TemplateComponent} the given {@link ContextComponent} is
+ * derived from.
*
- * @param test
- * The {@code ContextComponent} whose {@code TemplateComponent}
- * is requested.
- * @return {@code Optional} is empty if the given {@code ContextComponent}
- * is not derived from a template, which is data source specific.
+ * @param test The {@code ContextComponent} whose {@code TemplateComponent} is
+ * requested.
+ * @return {@code Optional} is empty if the given {@code ContextComponent} is
+ * not derived from a template, which is data source specific.
*/
public static Optional<TemplateTest> of(Test test) {
return Optional.ofNullable(getCore(test).getMutableStore().get(TemplateTest.class));
@@ -219,8 +211,7 @@
* Checks whether given {@link TemplateTestStepUsage} is contained in this
* template test.
*
- * @param templateTestStep
- * The {@code TemplateTestStepUsage}.
+ * @param templateTestStep The {@code TemplateTestStepUsage}.
* @return Returns {@code true} if given {@code TemplateTestStepUsage} is
* contained in this template test.
*/
diff --git a/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateTestStep.java b/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateTestStep.java
index 5b2a842..c28d968 100644
--- a/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateTestStep.java
+++ b/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateTestStep.java
@@ -52,8 +52,7 @@
/**
* Constructor.
*
- * @param core
- * The {@link Core}.
+ * @param core The {@link Core}.
*/
TemplateTestStep(Core core) {
super(core);
@@ -64,11 +63,10 @@
// ======================================================================
/**
- * Returns the related {@link TemplateRoot} with given {@link ContextType}
- * of this template test step.
+ * Returns the related {@link TemplateRoot} with given {@link ContextType} of
+ * this template test step.
*
- * @param contextType
- * Used as identifier.
+ * @param contextType Used as identifier.
* @return {@code Optional} is empty if a {@code TemplateRoot} of given
* {@code ContextType} does not exist.
*/
@@ -94,8 +92,7 @@
/**
* Replaces current {@link TemplateRoot} with the given one.
*
- * @param templateRoot
- * Is not allowed to be null.
+ * @param templateRoot Is not allowed to be null.
* @see #removeTemplateRoot(ContextType)
*/
public void setTemplateRoot(TemplateRoot templateRoot) {
@@ -105,10 +102,8 @@
/**
* Removes current {@link TemplateRoot} with given {@link ContextType}.
*
- * @param contextType
- * Used as identifier.
- * @return Returns {@code true} if the {@code TemplateRoot} has been
- * removed.
+ * @param contextType Used as identifier.
+ * @return Returns {@code true} if the {@code TemplateRoot} has been removed.
*/
public boolean removeTemplateRoot(ContextType contextType) {
boolean contained = getTemplateRoot(contextType).isPresent();
@@ -117,12 +112,11 @@
}
/**
- * Returns the {@link TemplateTestStep} the given {@link TestStep} is
- * derived from.
+ * Returns the {@link TemplateTestStep} the given {@link TestStep} is derived
+ * from.
*
- * @param testStep
- * The {@code TestStep} whose {@code TemplateTestStep} is
- * requested.
+ * @param testStep The {@code TestStep} whose {@code TemplateTestStep} is
+ * requested.
* @return {@code Optional} is empty if the given {@code TestStep} is not
* derived from a template.
*/
diff --git a/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateTestStepUsage.java b/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateTestStepUsage.java
index cf34b93..0e99d97 100644
--- a/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateTestStepUsage.java
+++ b/src/main/java/org/eclipse/mdm/api/dflt/model/TemplateTestStepUsage.java
@@ -77,8 +77,7 @@
/**
* Constructor.
*
- * @param core
- * The {@link Core}.
+ * @param core The {@link Core}.
*/
TemplateTestStepUsage(Core core) {
super(core);
@@ -102,8 +101,7 @@
/**
* Sets a new default active flag for this template test step usage.
*
- * @param defaultActive
- * The new default active flag.
+ * @param defaultActive The new default active flag.
*/
public void setDefaultActive(Boolean defaultActive) {
getValue(ATTR_DEFAULT_ACTIVE).set(defaultActive);
@@ -122,8 +120,7 @@
/**
* Sets a new optional flag for this template test step usage.
*
- * @param optional
- * The new optional flag.
+ * @param optional The new optional flag.
*/
public void setOptional(Boolean optional) {
getValue(ATTR_OPTIONAL).set(optional);
diff --git a/src/main/java/org/eclipse/mdm/api/dflt/model/ValueList.java b/src/main/java/org/eclipse/mdm/api/dflt/model/ValueList.java
index 137b54e..41a2d58 100644
--- a/src/main/java/org/eclipse/mdm/api/dflt/model/ValueList.java
+++ b/src/main/java/org/eclipse/mdm/api/dflt/model/ValueList.java
@@ -44,8 +44,7 @@
/**
* Constructor.
*
- * @param core
- * The {@link Core}.
+ * @param core The {@link Core}.
*/
ValueList(Core core) {
super(core);
@@ -58,10 +57,9 @@
/**
* Returns the {@link ValueListValue} identified by given name.
*
- * @param name
- * The name of the {@code ValueListValue}.
- * @return The {@code Optional} is empty if a {@code ValueListValue} with
- * given name does not exist.
+ * @param name The name of the {@code ValueListValue}.
+ * @return The {@code Optional} is empty if a {@code ValueListValue} with given
+ * name does not exist.
*/
public Optional<ValueListValue> getValueListValue(String name) {
return getValueListValues().stream().filter(vlv -> vlv.nameEquals(name)).findAny();
@@ -79,10 +77,9 @@
/**
* Removes the {@link ValueListValue} identified by given name.
*
- * @param name
- * Name of the {@code ValueListValue} that has to be removed.
- * @return Returns {@code true} if the {@code ValueListValues} with given
- * name has been removed.
+ * @param name Name of the {@code ValueListValue} that has to be removed.
+ * @return Returns {@code true} if the {@code ValueListValues} with given name
+ * has been removed.
*/
public boolean removeValueListValue(String name) {
Optional<ValueListValue> valueListValue = getValueListValue(name);
@@ -109,6 +106,5 @@
return sb.append(')').toString();
}
-
}
diff --git a/src/main/java/org/eclipse/mdm/api/dflt/model/ValueListValue.java b/src/main/java/org/eclipse/mdm/api/dflt/model/ValueListValue.java
index 48f1c2c..341935f 100644
--- a/src/main/java/org/eclipse/mdm/api/dflt/model/ValueListValue.java
+++ b/src/main/java/org/eclipse/mdm/api/dflt/model/ValueListValue.java
@@ -52,8 +52,7 @@
/**
* Constructor.
*
- * @param core
- * The {@link Core}.
+ * @param core The {@link Core}.
*/
ValueListValue(Core core) {
super(core);
diff --git a/src/main/java/org/eclipse/mdm/api/dflt/model/Versionable.java b/src/main/java/org/eclipse/mdm/api/dflt/model/Versionable.java
index 06b79a3..773bf89 100644
--- a/src/main/java/org/eclipse/mdm/api/dflt/model/Versionable.java
+++ b/src/main/java/org/eclipse/mdm/api/dflt/model/Versionable.java
@@ -65,8 +65,7 @@
/**
* Sets new version for this entity.
*
- * @param version
- * The new version.
+ * @param version The new version.
*/
default void setVersion(Integer version) {
getValue(ATTR_VERSION).set(version.toString());
@@ -84,8 +83,7 @@
/**
* Sets new {@link VersionState} for this entity.
*
- * @param versionState
- * The new {@code VersionState}.
+ * @param versionState The new {@code VersionState}.
*/
default void setVersionState(VersionState versionState) {
getValue(ATTR_VERSION_STATE).set(versionState);
@@ -101,8 +99,8 @@
}
/**
- * Checks whether this versionable is valid and therefore is no longer
- * allowed to be modified.
+ * Checks whether this versionable is valid and therefore is no longer allowed
+ * to be modified.
*
* @return Returns {@code true} if this versionable is valid.
*/
