issue #1814 - add javadoc and requireNonNull in factory methods

Signed-off-by: Lee Surprenant <lmsurpre@us.ibm.com>
LinuxForHealth · Apr 26, 2021 · 0f79983 · 0f79983
1 parent 89eb021
commit 0f79983
Show file tree

Hide file tree

Showing 23 changed files with 526 additions and 53 deletions.
diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/type/Base64Binary.java b/fhir-model/src/main/java/com/ibm/fhir/model/type/Base64Binary.java
@@ -55,19 +55,21 @@ public boolean hasChildren() {
      * Factory method for creating Base64Binary objects from a byte array; this array should be the actual value.
      * 
      * @param value
-     *     The byte array of to-be-encoded content
+     *     The byte array of to-be-encoded content, not null
      */
     public static Base64Binary of(byte[] value) {
+        Objects.requireNonNull(value, "value");
         return Base64Binary.builder().value(value).build();
     }
 
     /**
      * Factory method for creating Base64Binary objects from a Base64 encoded value.
      * 
      * @param value
-     *     The Base64 encoded string
+     *     The Base64 encoded string, not null
      */
     public static Base64Binary of(java.lang.String value) {
+        Objects.requireNonNull(value, "value");
         return Base64Binary.builder().value(value).build();
     }
 

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/type/Boolean.java b/fhir-model/src/main/java/com/ibm/fhir/model/type/Boolean.java
@@ -52,11 +52,25 @@ public boolean hasChildren() {
         return super.hasChildren();
     }
 
+    /**
+     * Factory method for creating Boolean objects from a java.lang.Boolean
+     * 
+     * @param value
+     *     A java.lang.Boolean, not null
+     */
     public static Boolean of(java.lang.Boolean value) {
+        Objects.requireNonNull(value, "value");
         return Boolean.builder().value(value).build();
     }
 
+    /**
+     * Factory method for creating Boolean objects from a java.lang.String
+     * 
+     * @param value
+     *     A java.lang.String value that can be parsed into a java.lang.Boolean, not null
+     */
     public static Boolean of(java.lang.String value) {
+        Objects.requireNonNull(value, "value");
         return Boolean.builder().value(value).build();
     }
 

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/type/Canonical.java b/fhir-model/src/main/java/com/ibm/fhir/model/type/Canonical.java
@@ -29,11 +29,27 @@ public boolean hasValue() {
         return (value != null);
     }
 
+    /**
+     * Factory method for creating Canonical objects from a java.lang.String
+     * 
+     * @param value
+     *     A java.lang.String, not null
+     */
     public static Canonical of(java.lang.String value) {
+        Objects.requireNonNull(value, "value");
         return Canonical.builder().value(value).build();
     }
 
+    /**
+     * Factory method for creating Canonical objects from a java.lang.String uri and version
+     * 
+     * @param value
+     *     A java.lang.String for the uri portion of the canonical reference, not null
+     * @param value
+     *     A java.lang.String for the version portion of the canonical reference
+     */
     public static Canonical of(java.lang.String uri, java.lang.String version) {
+        Objects.requireNonNull(uri, "uri");
         StringBuilder value = new StringBuilder(uri);
         if (version != null && !version.isEmpty()) {
             value.append('|');
@@ -42,7 +58,18 @@ public static Canonical of(java.lang.String uri, java.lang.String version) {
         return Canonical.builder().value(value.toString()).build();
     }
 
+    /**
+     * Factory method for creating Canonical objects from a java.lang.String uri, version, and fragment
+     * 
+     * @param value
+     *     A java.lang.String for the uri portion of the canonical reference, not null
+     * @param value
+     *     A java.lang.String for the version portion of the canonical reference
+     * @param value
+     *     A java.lang.String for the fragment portion of the canonical reference
+     */
     public static Canonical of(java.lang.String uri, java.lang.String version, java.lang.String fragment) {
+        Objects.requireNonNull(uri, "uri");
         StringBuilder value = new StringBuilder(uri);
         if (version != null && !version.isEmpty()) {
             value.append('|');
@@ -55,7 +82,14 @@ public static Canonical of(java.lang.String uri, java.lang.String version, java.
         return Canonical.builder().value(value.toString()).build();
     }
 
+    /**
+     * Factory method for creating Canonical objects from a java.lang.String
+     * 
+     * @param value
+     *     A java.lang.String that can be parsed into a valid FHIR uri value, not null
+     */
     public static Uri uri(java.lang.String value) {
+        Objects.requireNonNull(value, "value");
         return Canonical.builder().value(value).build();
     }
 

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/type/Code.java b/fhir-model/src/main/java/com/ibm/fhir/model/type/Code.java
@@ -32,15 +32,36 @@ public boolean hasValue() {
         return (value != null);
     }
 
+    /**
+     * Factory method for creating Code objects from a java.lang.String
+     * 
+     * @param value
+     *     A java.lang.String, not null
+     */
     public static Code of(java.lang.String value) {
+        Objects.requireNonNull(value, "value");
         return Code.builder().value(value).build();
     }
 
+    /**
+     * Factory method for creating Code objects from a java.lang.String
+     * 
+     * @param value
+     *     A java.lang.String, not null
+     */
     public static String string(java.lang.String value) {
+        Objects.requireNonNull(value, "value");
         return Code.builder().value(value).build();
     }
 
+    /**
+     * Factory method for creating Code objects from a java.lang.String
+     * 
+     * @param value
+     *     A java.lang.String that can be parsed into a valid FHIR code value, not null
+     */
     public static Code code(java.lang.String value) {
+        Objects.requireNonNull(value, "value");
         return Code.builder().value(value).build();
     }
 

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/type/Date.java b/fhir-model/src/main/java/com/ibm/fhir/model/type/Date.java
@@ -62,11 +62,25 @@ public boolean hasChildren() {
         return super.hasChildren();
     }
 
+    /**
+     * Factory method for creating Date objects from a TemporalAccessor
+     * 
+     * @param value
+     *     A TemporalAccessor, not null
+     */
     public static Date of(TemporalAccessor value) {
+        Objects.requireNonNull(value, "value");
         return Date.builder().value(value).build();
     }
 
+    /**
+     * Factory method for creating Date objects from a java.lang.String
+     * 
+     * @param value
+     *     A java.lang.String value that can be parsed by {@link #PARSER_FORMATTER}, not null
+     */
     public static Date of(java.lang.String value) {
+        Objects.requireNonNull(value, "value");
         return Date.builder().value(value).build();
     }
 

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/type/DateTime.java b/fhir-model/src/main/java/com/ibm/fhir/model/type/DateTime.java
@@ -73,19 +73,43 @@ public boolean hasChildren() {
         return super.hasChildren();
     }
 
+    /**
+     * Factory method for creating DateTime objects from a TemporalAccessor
+     * 
+     * @param value
+     *     A TemporalAccessor, not null
+     */
     public static DateTime of(TemporalAccessor value) {
+        Objects.requireNonNull(value, "value");
         return DateTime.builder().value(value).build();
     }
 
+    /**
+     * Factory method for creating DateTime objects from a java.lang.String
+     * 
+     * @param value
+     *     A java.lang.String value that can be parsed by {@link #PARSER_FORMATTER}, not null
+     */
     public static DateTime of(java.lang.String value) {
+        Objects.requireNonNull(value, "value");
         return DateTime.builder().value(value).build();
     }
 
+    /**
+     * Factory method for creating a DateTime that represents the current DateTime
+     */
     public static DateTime now() {
         return DateTime.builder().value(ZonedDateTime.now()).build();
     }
 
+    /**
+     * Factory method for creating a DateTime that represents the current DateTime in the passed time zone
+     * 
+     * @param offset
+     *     The ZoneOffset for the desired time zone, not null
+     */
     public static DateTime now(ZoneOffset offset) {
+        Objects.requireNonNull(offset, "offset");
         return DateTime.builder().value(ZonedDateTime.now(offset)).build();
     }
 

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/type/Decimal.java b/fhir-model/src/main/java/com/ibm/fhir/model/type/Decimal.java
@@ -50,15 +50,36 @@ public boolean hasChildren() {
         return super.hasChildren();
     }
 
+    /**
+     * Factory method for creating Decimal objects from a BigDecimal
+     * 
+     * @param value
+     *     A BigDecimal, not null
+     */
     public static Decimal of(BigDecimal value) {
+        Objects.requireNonNull(value, "value");
         return Decimal.builder().value(value).build();
     }
 
+    /**
+     * Factory method for creating Decimal objects from a Number
+     * 
+     * @param value
+     *     A Number, not null
+     */
     public static Decimal of(Number value) {
+        Objects.requireNonNull(value, "value");
         return Decimal.builder().value(value.toString()).build();
     }
 
+    /**
+     * Factory method for creating Decimal objects from a java.lang.String
+     * 
+     * @param value
+     *     A java.lang.String value that can be parsed into a BigDecimal, not null
+     */
     public static Decimal of(java.lang.String value) {
+        Objects.requireNonNull(value, "value");
         return Decimal.builder().value(value).build();
     }
 

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/type/Id.java b/fhir-model/src/main/java/com/ibm/fhir/model/type/Id.java
@@ -32,11 +32,25 @@ public boolean hasValue() {
         return (value != null);
     }
 
+    /**
+     * Factory method for creating Id objects from a java.lang.String
+     * 
+     * @param value
+     *     A java.lang.String, not null
+     */
     public static Id of(java.lang.String value) {
+        Objects.requireNonNull(value, "value");
         return Id.builder().value(value).build();
     }
 
+    /**
+     * Factory method for creating Id objects from a java.lang.String
+     * 
+     * @param value
+     *     A java.lang.String, not null
+     */
     public static String string(java.lang.String value) {
+        Objects.requireNonNull(value, "value");
         return Id.builder().value(value).build();
     }
 

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/type/Instant.java b/fhir-model/src/main/java/com/ibm/fhir/model/type/Instant.java
@@ -61,19 +61,43 @@ public boolean hasChildren() {
         return super.hasChildren();
     }
 
+    /**
+     * Factory method for creating Instant objects from a ZonedDateTime
+     * 
+     * @param value
+     *     A ZonedDateTime, not null
+     */
     public static Instant of(ZonedDateTime value) {
+        Objects.requireNonNull(value, "value");
         return Instant.builder().value(value).build();
     }
 
+    /**
+     * Factory method for creating Instant objects from a java.lang.String
+     * 
+     * @param value
+     *     A java.lang.String value that can be parsed by {@link #PARSER_FORMATTER}, not null
+     */
     public static Instant of(java.lang.String value) {
+        Objects.requireNonNull(value, "value");
         return Instant.builder().value(value).build();
     }
 
+    /**
+     * Factory method for creating a Instant that represents the current Instant
+     */
     public static Instant now() {
         return Instant.builder().value(ZonedDateTime.now()).build();
     }
 
+    /**
+     * Factory method for creating a Instant that represents the current Instant in the passed time zone
+     * 
+     * @param offset
+     *     the ZoneOffset for the desired time zone, not null
+     */
     public static Instant now(ZoneOffset offset) {
+        Objects.requireNonNull(offset, "offset");
         return Instant.builder().value(ZonedDateTime.now(offset)).build();
     }
 

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/type/Integer.java b/fhir-model/src/main/java/com/ibm/fhir/model/type/Integer.java
@@ -49,15 +49,36 @@ public boolean hasChildren() {
         return super.hasChildren();
     }
 
+    /**
+     * Factory method for creating Integer objects from a java.lang.Integer
+     * 
+     * @param value
+     *     A java.lang.Integer, not null
+     */
     public static Integer of(java.lang.Integer value) {
+        Objects.requireNonNull(value, "value");
         return Integer.builder().value(value).build();
     }
 
+    /**
+     * Factory method for creating Integer objects from a java.lang.String
+     * 
+     * @param value
+     *     A java.lang.String value that can be parsed into a java.lang.Integer, not null
+     */
     public static Integer of(java.lang.String value) {
+        Objects.requireNonNull(value, "value");
         return Integer.builder().value(value).build();
     }
 
+    /**
+     * Factory method for creating Integer objects from a java.lang.String
+     * 
+     * @param value
+     *     A java.lang.String that can be parsed into a java.lang.Integer, not null
+     */
     public static Integer integer(java.lang.String value) {
+        Objects.requireNonNull(value, "value");
         return Integer.builder().value(value).build();
     }
 

diff --git a/fhir-model/src/main/java/com/ibm/fhir/model/type/Markdown.java b/fhir-model/src/main/java/com/ibm/fhir/model/type/Markdown.java
@@ -29,11 +29,25 @@ public boolean hasValue() {
         return (value != null);
     }
 
+    /**
+     * Factory method for creating Markdown objects from a java.lang.String
+     * 
+     * @param value
+     *     A java.lang.String, not null
+     */
     public static Markdown of(java.lang.String value) {
+        Objects.requireNonNull(value, "value");
         return Markdown.builder().value(value).build();
     }
 
+    /**
+     * Factory method for creating Markdown objects from a java.lang.String
+     * 
+     * @param value
+     *     A java.lang.String, not null
+     */
     public static String string(java.lang.String value) {
+        Objects.requireNonNull(value, "value");
         return Markdown.builder().value(value).build();
     }