From dae0bfbe80edab19098be241c898edfcce251110 Mon Sep 17 00:00:00 2001
From: Daniel <d.hornung@indiscale.com>
Date: Fri, 4 Mar 2022 19:20:48 +0100
Subject: [PATCH] DOC: A bit of documentation.
---
.gitlab-ci.yml | 1 +
.../java/org/caosdb/datetime/FragmentDateTime.java | 2 ++
src/main/java/org/caosdb/datetime/UTCDateTime.java | 2 ++
.../caosdb/server/datatype/AbstractEnumValue.java | 6 +++---
.../org/caosdb/server/datatype/CollectionValue.java | 3 +++
.../org/caosdb/server/datatype/ReferenceValue.java | 13 ++++++++++++-
6 files changed, 23 insertions(+), 4 deletions(-)
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index e9b2b144..c2de130b 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -89,6 +89,7 @@ test:
trigger_build:
tags: [ docker ]
stage: deploy
+ needs: [ test ]
script:
- *env
diff --git a/src/main/java/org/caosdb/datetime/FragmentDateTime.java b/src/main/java/org/caosdb/datetime/FragmentDateTime.java
index a14192fc..38c16a98 100644
--- a/src/main/java/org/caosdb/datetime/FragmentDateTime.java
+++ b/src/main/java/org/caosdb/datetime/FragmentDateTime.java
@@ -20,6 +20,8 @@
*
* ** end header
*/
+
+/** @review Daniel Hornung 2022-03-04 */
package org.caosdb.datetime;
import java.util.Objects;
diff --git a/src/main/java/org/caosdb/datetime/UTCDateTime.java b/src/main/java/org/caosdb/datetime/UTCDateTime.java
index 765eb3f9..1dd86cc9 100644
--- a/src/main/java/org/caosdb/datetime/UTCDateTime.java
+++ b/src/main/java/org/caosdb/datetime/UTCDateTime.java
@@ -20,6 +20,8 @@
*
* ** end header
*/
+
+/** @review Daniel Hornung 2022-03-04 */
package org.caosdb.datetime;
import java.util.ArrayList;
diff --git a/src/main/java/org/caosdb/server/datatype/AbstractEnumValue.java b/src/main/java/org/caosdb/server/datatype/AbstractEnumValue.java
index ac93629c..be880025 100644
--- a/src/main/java/org/caosdb/server/datatype/AbstractEnumValue.java
+++ b/src/main/java/org/caosdb/server/datatype/AbstractEnumValue.java
@@ -1,10 +1,10 @@
/*
- * ** header v3.0
* This file is a part of the CaosDB Project.
*
* Copyright (C) 2018 Research Group Biomedical Physics,
* Max-Planck-Institute for Dynamics and Self-Organization Göttingen
*
+ *
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
@@ -17,9 +17,9 @@
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
- *
- * ** end header
*/
+
+/** @review Daniel Hornung 2022-03-04 */
package org.caosdb.server.datatype;
import com.google.common.base.Objects;
diff --git a/src/main/java/org/caosdb/server/datatype/CollectionValue.java b/src/main/java/org/caosdb/server/datatype/CollectionValue.java
index 2a55b47f..fc94f660 100644
--- a/src/main/java/org/caosdb/server/datatype/CollectionValue.java
+++ b/src/main/java/org/caosdb/server/datatype/CollectionValue.java
@@ -20,6 +20,8 @@
*
* ** end header
*/
+
+/** @review Daniel Hornung 2022-03-04 */
package org.caosdb.server.datatype;
import java.util.ArrayList;
@@ -81,6 +83,7 @@ public class CollectionValue implements Value, Iterable<IndexedSingleValue> {
return list.size();
}
+ /** Compares if the content is equal, regardless of the order. */
@Override
public boolean equals(Value val) {
if (val instanceof CollectionValue) {
diff --git a/src/main/java/org/caosdb/server/datatype/ReferenceValue.java b/src/main/java/org/caosdb/server/datatype/ReferenceValue.java
index 40b05e48..525d3c43 100644
--- a/src/main/java/org/caosdb/server/datatype/ReferenceValue.java
+++ b/src/main/java/org/caosdb/server/datatype/ReferenceValue.java
@@ -4,8 +4,9 @@
*
* Copyright (C) 2018 Research Group Biomedical Physics,
* Max-Planck-Institute for Dynamics and Self-Organization Göttingen
- * Copyright (C) 2020 IndiScale GmbH <info@indiscale.com>
+ * Copyright (C) 2022 IndiScale GmbH <info@indiscale.com>
* Copyright (C) 2020 Timm Fitschen <t.fitschen@indiscale.com>
+ * Copyright (C) 2022 Daniel Hornung <d.hornung@indiscale.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
@@ -22,6 +23,8 @@
*
* ** end header
*/
+
+/** @review Daniel Hornung 2022-03-04 */
package org.caosdb.server.datatype;
import java.util.Objects;
@@ -205,6 +208,14 @@ public class ReferenceValue implements SingleValue {
return false;
}
+ /**
+ * Test if this is equal to the other object.
+ *
+ * <p>Two references are equal, if 1) they both have IDs and their content is equal or 2) at least
+ * one does not have an ID, but their names are equal. Otherwise they are considered unequal.
+ *
+ * @param val The other object.
+ */
@Override
public boolean equals(Value val) {
if (val instanceof ReferenceValue) {
--
GitLab