summaryrefslogtreecommitdiffstats
path: root/model
diff options
context:
space:
mode:
authorliamfallon <liam.fallon@ericsson.com>2018-09-05 15:46:31 +0100
committerliamfallon <liam.fallon@ericsson.com>2018-09-06 13:26:24 +0100
commita41c877a6b1980e0e866699633e0289d9a3fdbb5 (patch)
tree4f8d15559549760c2e74880871ec08c3b8df2d0e /model
parent825ae627d4378c5cc7ab4b7d5f4b4ffefcb7977e (diff)
Fix package of apex examples and documents
The examples are not packaged correctly in the apex build and the client wars are missing The links and location of the documents are corrected. Some POM duplicate dependencies removed. Javadoc warnings removed. Issue-ID: POLICY-867 Change-Id: I555c29191c61c0a9887365d95005dbc584eddf04 Signed-off-by: liamfallon <liam.fallon@ericsson.com>
Diffstat (limited to 'model')
-rw-r--r--model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxArtifactKey.java4
-rw-r--r--model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxReferenceKey.java8
-rw-r--r--model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextAlbum.java8
-rw-r--r--model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextSchema.java6
-rwxr-xr-xmodel/utilities/src/main/java/org/onap/policy/apex/model/utilities/json/package-info.java26
5 files changed, 39 insertions, 13 deletions
diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxArtifactKey.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxArtifactKey.java
index 1f906ea22..7e39e5817 100644
--- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxArtifactKey.java
+++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxArtifactKey.java
@@ -39,7 +39,7 @@ import org.onap.policy.apex.model.utilities.Assertions;
* must have an {@link AxArtifactKey} to identify it. Concepts that are wholly contained in another concept are
* identified using a {@link AxReferenceKey} key.
*
- * <p>Key validation checks that the name and version fields match the {@link NAME_REGEXP} and {@link VERSION_REGEXP}
+ * <p>Key validation checks that the name and version fields match the NAME_REGEXP and VERSION_REGEXP
* regular expressions respectively.
*/
@Embeddable
@@ -94,7 +94,7 @@ public class AxArtifactKey extends AxKey {
/**
* Constructor to create a key using the key and version from the specified key ID.
*
- * @param id the key ID in a format that respects the {@link KEY_ID_REGEXP}
+ * @param id the key ID in a format that respects the KEY_ID_REGEXP
*/
public AxArtifactKey(final String id) {
Assertions.argumentNotNull(id, "id may not be null");
diff --git a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxReferenceKey.java b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxReferenceKey.java
index 55ea95c3a..57196ade7 100644
--- a/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxReferenceKey.java
+++ b/model/basic-model/src/main/java/org/onap/policy/apex/model/basicmodel/concepts/AxReferenceKey.java
@@ -47,9 +47,9 @@ import org.onap.policy.apex.model.utilities.Assertions;
* <p>If a reference key's parent is itself a reference key, then the parent's local name must be set in the reference
* key. If the parent is a first order concept, then the parent's local name in the key will be set to NULL.
*
- * <p>Key validation checks that the parent name and parent version fields match the {@link NAME_REGEXP} and
- * {@link VERSION_REGEXP} regular expressions respectively and that the local name fields match the
- * {@link LOCAL_NAME_REGEXP} regular expression.
+ * <p>Key validation checks that the parent name and parent version fields match the NAME_REGEXP and
+ * VERSION_REGEXP regular expressions respectively and that the local name fields match the
+ * LOCAL_NAME_REGEXP regular expression.
*/
@Embeddable
@XmlAccessorType(XmlAccessType.FIELD)
@@ -203,7 +203,7 @@ public class AxReferenceKey extends AxKey {
* Constructor to create a key from the specified key ID.
*
* @param id
- * the key ID in a format that respects the {@link KEY_ID_REGEXP}
+ * the key ID in a format that respects the KEY_ID_REGEXP
*/
public AxReferenceKey(final String id) {
final String conditionedId = Assertions.validateStringParameter("id", id, REFERENCE_KEY_ID_REGEXP);
diff --git a/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextAlbum.java b/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextAlbum.java
index 27f9b8b9b..32555662e 100644
--- a/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextAlbum.java
+++ b/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextAlbum.java
@@ -62,7 +62,7 @@ import org.onap.policy.apex.model.utilities.Assertions;
* read objects from the context album.
* <p>
* Validation checks that the album key and the context schema key are not null and that the scope field is not
- * undefined and matches the regular expression {@link SCOPE_REGEXP}.
+ * undefined and matches the regular expression SCOPE_REGEXP.
*/
@Entity
@Table(name = "AxContextAlbum")
@@ -113,7 +113,7 @@ public class AxContextAlbum extends AxConcept {
/**
* The default constructor creates a context album with a null artifact key. The scope of the context album is set
- * as {@link SCOPE_UNDEFINED}, the album is writable, and the artifact key of the context schema is set to the null
+ * as SCOPE_UNDEFINED, the album is writable, and the artifact key of the context schema is set to the null
* artifact key.
*/
public AxContextAlbum() {
@@ -134,7 +134,7 @@ public class AxContextAlbum extends AxConcept {
/**
* The keyed constructor creates a context album with the specified artifact key. The scope of the context album is
- * set as {@link SCOPE_UNDEFINED}, the album is writable, and the artifact key of the context schema is set to the
+ * set as SCOPE_UNDEFINED, the album is writable, and the artifact key of the context schema is set to the
* null artifact key.
*
* @param key the key of the context album
@@ -147,7 +147,7 @@ public class AxContextAlbum extends AxConcept {
* Constructor that sets all the fields of the context album.
*
* @param key the key of the context album
- * @param scope the scope field, must match the regular expression {@link SCOPE_REGEXP}
+ * @param scope the scope field, must match the regular expression SCOPE_REGEXP
* @param isWritable specifies whether the context album will be writable or not
* @param itemSchema the artifact key of the context schema to use for this context album
*/
diff --git a/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextSchema.java b/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextSchema.java
index bf8289ecb..87c89376e 100644
--- a/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextSchema.java
+++ b/model/context-model/src/main/java/org/onap/policy/apex/model/contextmodel/concepts/AxContextSchema.java
@@ -58,7 +58,7 @@ import org.onap.policy.apex.model.utilities.Assertions;
* {@link AxContextSchema} being defined as @code cell} objects.
* <p>
* Validation checks that the schema key is not null. It also checks that the schema flavour is defined and matches the
- * regular expression {@link SCHEMA_FLAVOUR_REGEXP}. Finally, validation checks that the defined schema is not a blank
+ * regular expression SCHEMA_FLAVOUR_REGEXP. Finally, validation checks that the defined schema is not a blank
* or empty string.
*/
@Entity
@@ -100,7 +100,7 @@ public class AxContextSchema extends AxConcept {
/**
* The default constructor creates a context schema with a null artifact key. The flavour of the context album is
- * set as {@link SCHEMA_FLAVOUR_UNDEFINED} and the schema itself is defined as an empty string.
+ * set as SCHEMA_FLAVOUR_UNDEFINED and the schema itself is defined as an empty string.
*/
public AxContextSchema() {
this(new AxArtifactKey());
@@ -118,7 +118,7 @@ public class AxContextSchema extends AxConcept {
/**
* The key constructor creates a context schema with the given artifact key. The flavour of the context album is set
- * as {@link SCHEMA_FLAVOUR_UNDEFINED} and the schema itself is defined as an empty string.
+ * as SCHEMA_FLAVOUR_UNDEFINED and the schema itself is defined as an empty string.
*
* @param key the key
*/
diff --git a/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/json/package-info.java b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/json/package-info.java
new file mode 100755
index 000000000..f9d1304d7
--- /dev/null
+++ b/model/utilities/src/main/java/org/onap/policy/apex/model/utilities/json/package-info.java
@@ -0,0 +1,26 @@
+/*
+ * ============LICENSE_START=======================================================
+ * Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+/**
+ * Provides a utility class for reading JSON streams.
+ *
+ * @author Liam Fallon (liam.fallon@ericsson.com)
+ */
+package org.onap.policy.apex.model.utilities.json;