diff --git a/src/main/java/io/github/orangain/jsonmatch/JsonMatch.java b/src/main/java/io/github/orangain/jsonmatch/JsonMatch.java index 721a878..fd00758 100644 --- a/src/main/java/io/github/orangain/jsonmatch/JsonMatch.java +++ b/src/main/java/io/github/orangain/jsonmatch/JsonMatch.java @@ -7,6 +7,7 @@ import io.github.orangain.jsonmatch.json.JsonUtil; import io.github.orangain.jsonmatch.parser.JsonMatchPatternParser; import io.github.orangain.jsonmatch.pattern.JsonPatternNode; +import org.jetbrains.annotations.NotNull; import java.util.Optional; @@ -16,7 +17,8 @@ public class JsonMatch { /** * Asserts that the actual JSON matches the pattern JSON. - * @param actualJson The actual JSON string. + * + * @param actualJson The actual JSON string. * @param patternJson The pattern JSON string. */ public static void assertJsonMatches(String actualJson, String patternJson) { @@ -28,7 +30,8 @@ public static void assertJsonMatches(String actualJson, String patternJson) { /** * Checks if the actual JSON matches the pattern JSON. - * @param actualJson The actual JSON string. + * + * @param actualJson The actual JSON string. * @param patternJson The pattern JSON string. * @return An {@link Optional} of {@link JsonMatchError} if the actual JSON does not match the pattern JSON. */ diff --git a/src/main/java/io/github/orangain/jsonmatch/JsonMatchError.java b/src/main/java/io/github/orangain/jsonmatch/JsonMatchError.java index 8105143..a5addcc 100644 --- a/src/main/java/io/github/orangain/jsonmatch/JsonMatchError.java +++ b/src/main/java/io/github/orangain/jsonmatch/JsonMatchError.java @@ -13,8 +13,9 @@ public class JsonMatchError { /** * Constructor of the JSON match error. - * @param message The error message. - * @param actual The actual JSON string. + * + * @param message The error message. + * @param actual The actual JSON string. * @param expected The expected JSON string. */ public JsonMatchError(@NotNull String message, @NotNull String actual, @NotNull String expected) { @@ -25,6 +26,7 @@ public JsonMatchError(@NotNull String message, @NotNull String actual, @NotNull /** * Get the error message. + * * @return The error message. */ public @NotNull String getMessage() { @@ -33,6 +35,7 @@ public JsonMatchError(@NotNull String message, @NotNull String actual, @NotNull /** * Get the actual JSON string. + * * @return The actual JSON string. */ public @NotNull String getActual() { @@ -41,6 +44,7 @@ public JsonMatchError(@NotNull String message, @NotNull String actual, @NotNull /** * Get the expected JSON string. + * * @return The expected JSON string. */ public @NotNull String getExpected() { diff --git a/src/main/java/io/github/orangain/jsonmatch/JsonStringAssert.java b/src/main/java/io/github/orangain/jsonmatch/JsonStringAssert.java index 504fb93..2143b52 100644 --- a/src/main/java/io/github/orangain/jsonmatch/JsonStringAssert.java +++ b/src/main/java/io/github/orangain/jsonmatch/JsonStringAssert.java @@ -1,6 +1,7 @@ package io.github.orangain.jsonmatch; import org.assertj.core.api.AbstractAssert; +import org.jetbrains.annotations.NotNull; /** * AssertJ assertion for JSON strings. @@ -9,7 +10,8 @@ public class JsonStringAssert extends AbstractAssert { /** * Constructor of the JSON string assertion. - * @param s The JSON string to make assertions on. + * + * @param s The JSON string to make assertions on. * @param selfType The class of the assertion. */ public JsonStringAssert(String s, Class selfType) { @@ -18,6 +20,7 @@ public JsonStringAssert(String s, Class selfType) { /** * Creates a new instance of JsonStringAssert allowing to perform assertions on the provided JSON string. + * * @param actual The JSON string to make assertions on. * @return A new instance of JsonStringAssert. */ @@ -27,6 +30,7 @@ public JsonStringAssert(String s, Class selfType) { /** * Asserts that the JSON string matches the pattern JSON string. + * * @param patternJson The pattern JSON string. * @return This assertion object. */ diff --git a/src/main/java/io/github/orangain/jsonmatch/json/JsonPath.java b/src/main/java/io/github/orangain/jsonmatch/json/JsonPath.java index 6621ff8..b50cbe3 100644 --- a/src/main/java/io/github/orangain/jsonmatch/json/JsonPath.java +++ b/src/main/java/io/github/orangain/jsonmatch/json/JsonPath.java @@ -15,6 +15,7 @@ public class JsonPath { /** * Constructor of the JSON path. + * * @param path The JSON path string. */ public JsonPath(@NotNull String path) { @@ -23,6 +24,7 @@ public JsonPath(@NotNull String path) { /** * Get the JSON path for the array item. + * * @param index The index of the array item. * @return The JSON path for the array item. */ @@ -32,6 +34,7 @@ public JsonPath(@NotNull String path) { /** * Get the JSON path for the object field. + * * @param fieldName The name of the object field. * @return The JSON path for the object field. */ diff --git a/src/main/java/io/github/orangain/jsonmatch/json/JsonUtil.java b/src/main/java/io/github/orangain/jsonmatch/json/JsonUtil.java index 8e05f60..517163e 100644 --- a/src/main/java/io/github/orangain/jsonmatch/json/JsonUtil.java +++ b/src/main/java/io/github/orangain/jsonmatch/json/JsonUtil.java @@ -2,6 +2,8 @@ import com.fasterxml.jackson.core.JsonProcessingException; import com.fasterxml.jackson.databind.ObjectMapper; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; /** * JSON utility class. @@ -11,6 +13,7 @@ public class JsonUtil { /** * Get the singleton instance of the Jackson {@link ObjectMapper}. + * * @return The singleton instance of the Jackson {@link ObjectMapper}. */ public static @NotNull ObjectMapper getObjectMapper() { @@ -22,6 +25,7 @@ public class JsonUtil { /** * Convert an object to a JSON string. This method is unchecked exception version of {@link ObjectMapper#writeValueAsString(Object)}. + * * @param value The object to convert to a JSON string. * @return The JSON string. */ diff --git a/src/main/java/io/github/orangain/jsonmatch/parser/JsonMatchPatternParser.java b/src/main/java/io/github/orangain/jsonmatch/parser/JsonMatchPatternParser.java index 385c736..bc8a9db 100644 --- a/src/main/java/io/github/orangain/jsonmatch/parser/JsonMatchPatternParser.java +++ b/src/main/java/io/github/orangain/jsonmatch/parser/JsonMatchPatternParser.java @@ -19,6 +19,7 @@ public class JsonMatchPatternParser { /** * Parse a JSON match pattern from a JSON node. + * * @param jsonNode The JSON node to parse. * @return The parsed JSON match pattern node. */ diff --git a/src/main/java/io/github/orangain/jsonmatch/pattern/ArrayLiteralPatternNode.java b/src/main/java/io/github/orangain/jsonmatch/pattern/ArrayLiteralPatternNode.java index d59a077..9293f81 100644 --- a/src/main/java/io/github/orangain/jsonmatch/pattern/ArrayLiteralPatternNode.java +++ b/src/main/java/io/github/orangain/jsonmatch/pattern/ArrayLiteralPatternNode.java @@ -15,7 +15,8 @@ public class ArrayLiteralPatternNode extends ArrayPatternNode { /** * Constructor of the JSON array pattern node. - * @param expected The string representation of the expected JSON array pattern. + * + * @param expected The string representation of the expected JSON array pattern. * @param expectedChildren The expected patterns for each element of the array. */ public ArrayLiteralPatternNode(@NotNull String expected, @NotNull List expectedChildren) { diff --git a/src/main/java/io/github/orangain/jsonmatch/pattern/ArrayMarkerPatternNode.java b/src/main/java/io/github/orangain/jsonmatch/pattern/ArrayMarkerPatternNode.java index 7ea5cb1..e97784e 100644 --- a/src/main/java/io/github/orangain/jsonmatch/pattern/ArrayMarkerPatternNode.java +++ b/src/main/java/io/github/orangain/jsonmatch/pattern/ArrayMarkerPatternNode.java @@ -22,6 +22,7 @@ public class ArrayMarkerPatternNode extends ArrayPatternNode { /** * Constructor of the JSON array pattern node with no expected size or child pattern. + * * @param expected The string representation of the expected JSON array pattern. */ public ArrayMarkerPatternNode(@NotNull String expected) { @@ -30,7 +31,8 @@ public ArrayMarkerPatternNode(@NotNull String expected) { /** * Constructor of the JSON array pattern node with child pattern but no expected size. - * @param expected The string representation of the expected JSON array pattern. + * + * @param expected The string representation of the expected JSON array pattern. * @param expectedChildPattern The expected pattern for each element of the array. */ public ArrayMarkerPatternNode(@NotNull String expected, @Nullable JsonPatternNode expectedChildPattern) { @@ -39,8 +41,9 @@ public ArrayMarkerPatternNode(@NotNull String expected, @Nullable JsonPatternNod /** * Constructor of the JSON array pattern node with expected size and child pattern. - * @param expected The string representation of the expected JSON array pattern. - * @param expectedSize The expected size of the array. + * + * @param expected The string representation of the expected JSON array pattern. + * @param expectedSize The expected size of the array. * @param expectedChildPattern The expected pattern for each element of the array. */ public ArrayMarkerPatternNode(@NotNull String expected, int expectedSize, @Nullable JsonPatternNode expectedChildPattern) { diff --git a/src/main/java/io/github/orangain/jsonmatch/pattern/ArrayPatternNode.java b/src/main/java/io/github/orangain/jsonmatch/pattern/ArrayPatternNode.java index 69c2e5c..794436c 100644 --- a/src/main/java/io/github/orangain/jsonmatch/pattern/ArrayPatternNode.java +++ b/src/main/java/io/github/orangain/jsonmatch/pattern/ArrayPatternNode.java @@ -12,6 +12,7 @@ public abstract class ArrayPatternNode extends JsonPatternNode { /** * Constructor of the JSON array pattern node. + * * @param expected The string representation of the expected JSON array pattern. */ protected ArrayPatternNode(@NotNull String expected) { @@ -34,7 +35,8 @@ protected ArrayPatternNode(@NotNull String expected) { /** * Checks if the size of the actual JSON array node matches the pattern node. - * @param jsonPath The JSON path to the actual JSON node. + * + * @param jsonPath The JSON path to the actual JSON node. * @param actualNode The actual JSON node. * @return An empty optional if the size matches, or an error detail if it does not match. */ @@ -42,7 +44,8 @@ protected ArrayPatternNode(@NotNull String expected) { /** * Checks if the children of the actual JSON array node matches the pattern node. - * @param jsonPath The JSON path to the actual JSON node. + * + * @param jsonPath The JSON path to the actual JSON node. * @param actualNode The actual JSON node. * @return An empty optional if the children matches, or an error detail if they do not match. */ diff --git a/src/main/java/io/github/orangain/jsonmatch/pattern/JsonMatchErrorDetail.java b/src/main/java/io/github/orangain/jsonmatch/pattern/JsonMatchErrorDetail.java index 477b1e2..b25121e 100644 --- a/src/main/java/io/github/orangain/jsonmatch/pattern/JsonMatchErrorDetail.java +++ b/src/main/java/io/github/orangain/jsonmatch/pattern/JsonMatchErrorDetail.java @@ -14,10 +14,11 @@ public class JsonMatchErrorDetail { /** * Constructor of the JSON match error detail. - * @param path The JSON path where the error occurred. - * @param actual The actual JSON string. + * + * @param path The JSON path where the error occurred. + * @param actual The actual JSON string. * @param expected The expected JSON string. - * @param reason The reason for the error. + * @param reason The reason for the error. */ public JsonMatchErrorDetail(@NotNull JsonPath path, @NotNull String actual, @NotNull String expected, @NotNull String reason) { this.path = path; @@ -36,6 +37,7 @@ public JsonMatchErrorDetail(@NotNull JsonPath path, @NotNull String actual, @Not /** * Creates a new JSON match error detail with the expected JSON string. + * * @param expected The expected JSON string. * @return A new JSON match error detail. */ diff --git a/src/main/java/io/github/orangain/jsonmatch/pattern/JsonPatternNode.java b/src/main/java/io/github/orangain/jsonmatch/pattern/JsonPatternNode.java index 3276004..f559ed4 100644 --- a/src/main/java/io/github/orangain/jsonmatch/pattern/JsonPatternNode.java +++ b/src/main/java/io/github/orangain/jsonmatch/pattern/JsonPatternNode.java @@ -17,6 +17,7 @@ public abstract class JsonPatternNode { /** * Constructor of the JSON pattern node. + * * @param expected The string representation of the expected JSON pattern. */ protected JsonPatternNode(@NotNull String expected) { @@ -25,7 +26,8 @@ protected JsonPatternNode(@NotNull String expected) { /** * Matches the JSON pattern node against the actual JSON node. - * @param path The JSON path to the actual JSON node. + * + * @param path The JSON path to the actual JSON node. * @param actualNode The actual JSON node. * @return An empty optional if the actual JSON node matches the pattern node, or an error detail if it does not match. */ @@ -33,9 +35,10 @@ protected JsonPatternNode(@NotNull String expected) { /** * Creates an error detail. - * @param path The JSON path to the actual JSON node. + * + * @param path The JSON path to the actual JSON node. * @param actualNode The actual JSON node. - * @param reason The reason why the actual JSON node does not match the pattern node. + * @param reason The reason why the actual JSON node does not match the pattern node. * @return An error detail. */ protected @NotNull JsonMatchErrorDetail error(@NotNull JsonPath path, @NotNull JsonNode actualNode, @NotNull String reason) { @@ -44,6 +47,7 @@ protected JsonPatternNode(@NotNull String expected) { /** * Returns if the pattern node can be missing. + * * @return True if the pattern node can be missing, false otherwise. */ protected boolean canBeMissing() { diff --git a/src/main/java/io/github/orangain/jsonmatch/pattern/ObjectLiteralPatternNode.java b/src/main/java/io/github/orangain/jsonmatch/pattern/ObjectLiteralPatternNode.java index 20516c7..ad60a98 100644 --- a/src/main/java/io/github/orangain/jsonmatch/pattern/ObjectLiteralPatternNode.java +++ b/src/main/java/io/github/orangain/jsonmatch/pattern/ObjectLiteralPatternNode.java @@ -19,7 +19,8 @@ public class ObjectLiteralPatternNode extends ObjectPatternNode { /** * Constructor of the JSON object pattern node. - * @param expected The string representation of the expected JSON object pattern. + * + * @param expected The string representation of the expected JSON object pattern. * @param expectedChildren The expected pairs of key and value pattern node. */ public ObjectLiteralPatternNode(@NotNull String expected, @NotNull Map expectedChildren) { diff --git a/src/main/java/io/github/orangain/jsonmatch/pattern/ObjectMarkerPatternNode.java b/src/main/java/io/github/orangain/jsonmatch/pattern/ObjectMarkerPatternNode.java index 9ba1f8a..c589603 100644 --- a/src/main/java/io/github/orangain/jsonmatch/pattern/ObjectMarkerPatternNode.java +++ b/src/main/java/io/github/orangain/jsonmatch/pattern/ObjectMarkerPatternNode.java @@ -12,6 +12,7 @@ public class ObjectMarkerPatternNode extends ObjectPatternNode { /** * Constructor of the JSON object pattern node. + * * @param expected The string representation of the expected JSON object pattern. */ public ObjectMarkerPatternNode(@NotNull String expected) { diff --git a/src/main/java/io/github/orangain/jsonmatch/pattern/ObjectPatternNode.java b/src/main/java/io/github/orangain/jsonmatch/pattern/ObjectPatternNode.java index 02dc481..06c68be 100644 --- a/src/main/java/io/github/orangain/jsonmatch/pattern/ObjectPatternNode.java +++ b/src/main/java/io/github/orangain/jsonmatch/pattern/ObjectPatternNode.java @@ -8,6 +8,7 @@ public abstract class ObjectPatternNode extends JsonPatternNode { /** * Constructor of the JSON object pattern node. + * * @param expected The string representation of the expected JSON object pattern. */ protected ObjectPatternNode(@NotNull String expected) { diff --git a/src/main/java/io/github/orangain/jsonmatch/pattern/ValueLiteralPatternNode.java b/src/main/java/io/github/orangain/jsonmatch/pattern/ValueLiteralPatternNode.java index eb1d7e7..e4c5104 100644 --- a/src/main/java/io/github/orangain/jsonmatch/pattern/ValueLiteralPatternNode.java +++ b/src/main/java/io/github/orangain/jsonmatch/pattern/ValueLiteralPatternNode.java @@ -14,6 +14,7 @@ public class ValueLiteralPatternNode extends ValuePatternNode { /** * Constructor of the JSON simple value pattern node. + * * @param expectedJsonNode The expected JSON value node. */ public ValueLiteralPatternNode(@NotNull JsonNode expectedJsonNode) { diff --git a/src/main/java/io/github/orangain/jsonmatch/pattern/ValuePatternNode.java b/src/main/java/io/github/orangain/jsonmatch/pattern/ValuePatternNode.java index 79686e6..2780d05 100644 --- a/src/main/java/io/github/orangain/jsonmatch/pattern/ValuePatternNode.java +++ b/src/main/java/io/github/orangain/jsonmatch/pattern/ValuePatternNode.java @@ -8,6 +8,7 @@ public abstract class ValuePatternNode extends JsonPatternNode { /** * Constructor of the JSON simple pattern node. + * * @param expected The string representation of the expected JSON simple pattern. */ protected ValuePatternNode(@NotNull String expected) { diff --git a/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/DateMarkerPatternNode.java b/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/DateMarkerPatternNode.java index 6b6738a..7aa545b 100644 --- a/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/DateMarkerPatternNode.java +++ b/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/DateMarkerPatternNode.java @@ -1,9 +1,9 @@ package io.github.orangain.jsonmatch.pattern.valuemarker; import com.fasterxml.jackson.databind.JsonNode; -import io.github.orangain.jsonmatch.pattern.JsonMatchErrorDetail; import io.github.orangain.jsonmatch.json.JsonPath; import io.github.orangain.jsonmatch.json.JsonUtil; +import io.github.orangain.jsonmatch.pattern.JsonMatchErrorDetail; import io.github.orangain.jsonmatch.pattern.ValuePatternNode; import org.jetbrains.annotations.NotNull; @@ -20,6 +20,7 @@ public class DateMarkerPatternNode extends ValuePatternNode { /** * Constructor of the JSON date pattern node. + * * @param expected The string representation of the expected JSON date pattern. */ public DateMarkerPatternNode(@NotNull String expected) { @@ -28,6 +29,7 @@ public DateMarkerPatternNode(@NotNull String expected) { /** * Get the singleton instance of the JSON date pattern node. + * * @return The singleton instance of the JSON date pattern node. */ public static DateMarkerPatternNode getInstance() { diff --git a/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/DateTimeMarkerPatternNode.java b/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/DateTimeMarkerPatternNode.java index d965aa8..f2053a0 100644 --- a/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/DateTimeMarkerPatternNode.java +++ b/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/DateTimeMarkerPatternNode.java @@ -1,9 +1,9 @@ package io.github.orangain.jsonmatch.pattern.valuemarker; import com.fasterxml.jackson.databind.JsonNode; -import io.github.orangain.jsonmatch.pattern.JsonMatchErrorDetail; import io.github.orangain.jsonmatch.json.JsonPath; import io.github.orangain.jsonmatch.json.JsonUtil; +import io.github.orangain.jsonmatch.pattern.JsonMatchErrorDetail; import io.github.orangain.jsonmatch.pattern.ValuePatternNode; import org.jetbrains.annotations.NotNull; @@ -20,6 +20,7 @@ public class DateTimeMarkerPatternNode extends ValuePatternNode { /** * Constructor of the JSON date-time pattern node. + * * @param expected The string representation of the expected JSON date-time pattern. */ public DateTimeMarkerPatternNode(@NotNull String expected) { diff --git a/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/IgnoreMarkerPatternNode.java b/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/IgnoreMarkerPatternNode.java index 24723da..285b62d 100644 --- a/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/IgnoreMarkerPatternNode.java +++ b/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/IgnoreMarkerPatternNode.java @@ -1,9 +1,9 @@ package io.github.orangain.jsonmatch.pattern.valuemarker; import com.fasterxml.jackson.databind.JsonNode; -import io.github.orangain.jsonmatch.pattern.JsonMatchErrorDetail; import io.github.orangain.jsonmatch.json.JsonPath; import io.github.orangain.jsonmatch.json.JsonUtil; +import io.github.orangain.jsonmatch.pattern.JsonMatchErrorDetail; import io.github.orangain.jsonmatch.pattern.JsonPatternNode; import io.github.orangain.jsonmatch.pattern.ValuePatternNode; import org.jetbrains.annotations.NotNull; @@ -18,6 +18,7 @@ public class IgnoreMarkerPatternNode extends ValuePatternNode { /** * Constructor of the JSON ignore marker pattern node. + * * @param expected The string representation of the expected JSON ignore marker pattern. */ public IgnoreMarkerPatternNode(@NotNull String expected) { @@ -26,6 +27,7 @@ public IgnoreMarkerPatternNode(@NotNull String expected) { /** * Get the singleton instance of the JSON ignore marker pattern node. + * * @return The singleton instance of the JSON ignore marker pattern node. */ public static JsonPatternNode getInstance() { diff --git a/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/NotNullMarkerPatternNode.java b/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/NotNullMarkerPatternNode.java index 34f9f2b..afe52ce 100644 --- a/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/NotNullMarkerPatternNode.java +++ b/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/NotNullMarkerPatternNode.java @@ -1,9 +1,9 @@ package io.github.orangain.jsonmatch.pattern.valuemarker; import com.fasterxml.jackson.databind.JsonNode; -import io.github.orangain.jsonmatch.pattern.JsonMatchErrorDetail; import io.github.orangain.jsonmatch.json.JsonPath; import io.github.orangain.jsonmatch.json.JsonUtil; +import io.github.orangain.jsonmatch.pattern.JsonMatchErrorDetail; import io.github.orangain.jsonmatch.pattern.ValuePatternNode; import org.jetbrains.annotations.NotNull; @@ -17,6 +17,7 @@ public class NotNullMarkerPatternNode extends ValuePatternNode { /** * Constructor of the JSON not-null pattern node. + * * @param expected The string representation of the expected JSON not-null pattern. */ public NotNullMarkerPatternNode(@NotNull String expected) { @@ -25,6 +26,7 @@ public NotNullMarkerPatternNode(@NotNull String expected) { /** * Get the singleton instance of the JSON not-null pattern node. + * * @return The singleton instance of the JSON not-null pattern node. */ public static NotNullMarkerPatternNode getInstance() { diff --git a/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/NotPresentMarkerPatternNode.java b/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/NotPresentMarkerPatternNode.java index 0572b47..49fabb9 100644 --- a/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/NotPresentMarkerPatternNode.java +++ b/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/NotPresentMarkerPatternNode.java @@ -1,9 +1,9 @@ package io.github.orangain.jsonmatch.pattern.valuemarker; import com.fasterxml.jackson.databind.JsonNode; -import io.github.orangain.jsonmatch.pattern.JsonMatchErrorDetail; import io.github.orangain.jsonmatch.json.JsonPath; import io.github.orangain.jsonmatch.json.JsonUtil; +import io.github.orangain.jsonmatch.pattern.JsonMatchErrorDetail; import io.github.orangain.jsonmatch.pattern.ValuePatternNode; import org.jetbrains.annotations.NotNull; @@ -17,6 +17,7 @@ public class NotPresentMarkerPatternNode extends ValuePatternNode { /** * Constructor of the JSON not-present pattern node. + * * @param expected The string representation of the expected JSON not-present pattern. */ public NotPresentMarkerPatternNode(@NotNull String expected) { @@ -25,6 +26,7 @@ public NotPresentMarkerPatternNode(@NotNull String expected) { /** * Get the singleton instance of the JSON not-present pattern node. + * * @return The singleton instance of the JSON not-present pattern node. */ public static NotPresentMarkerPatternNode getInstance() { diff --git a/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/PresentMarkerPatternNode.java b/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/PresentMarkerPatternNode.java index b23d75b..745d8d4 100644 --- a/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/PresentMarkerPatternNode.java +++ b/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/PresentMarkerPatternNode.java @@ -1,9 +1,9 @@ package io.github.orangain.jsonmatch.pattern.valuemarker; import com.fasterxml.jackson.databind.JsonNode; -import io.github.orangain.jsonmatch.pattern.JsonMatchErrorDetail; import io.github.orangain.jsonmatch.json.JsonPath; import io.github.orangain.jsonmatch.json.JsonUtil; +import io.github.orangain.jsonmatch.pattern.JsonMatchErrorDetail; import io.github.orangain.jsonmatch.pattern.ValuePatternNode; import org.jetbrains.annotations.NotNull; @@ -17,6 +17,7 @@ public class PresentMarkerPatternNode extends ValuePatternNode { /** * Constructor of the JSON present pattern node. + * * @param expected The string representation of the expected JSON present pattern. */ public PresentMarkerPatternNode(@NotNull String expected) { @@ -25,6 +26,7 @@ public PresentMarkerPatternNode(@NotNull String expected) { /** * Get the singleton instance of the JSON present pattern node. + * * @return The singleton instance of the JSON present pattern node. */ public static PresentMarkerPatternNode getInstance() { diff --git a/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/RegexMarkerPatternNode.java b/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/RegexMarkerPatternNode.java index 8309dfb..85de35f 100644 --- a/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/RegexMarkerPatternNode.java +++ b/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/RegexMarkerPatternNode.java @@ -1,8 +1,8 @@ package io.github.orangain.jsonmatch.pattern.valuemarker; import com.fasterxml.jackson.databind.JsonNode; -import io.github.orangain.jsonmatch.pattern.JsonMatchErrorDetail; import io.github.orangain.jsonmatch.json.JsonPath; +import io.github.orangain.jsonmatch.pattern.JsonMatchErrorDetail; import io.github.orangain.jsonmatch.pattern.ValuePatternNode; import org.jetbrains.annotations.NotNull; @@ -17,8 +17,9 @@ public class RegexMarkerPatternNode extends ValuePatternNode { /** * Constructor of the JSON regex marker pattern node. + * * @param expected The string representation of the expected JSON regex marker pattern. - * @param pattern The regex pattern string to match. + * @param pattern The regex pattern string to match. */ public RegexMarkerPatternNode(@NotNull String expected, @NotNull String pattern) { this(expected, Pattern.compile(pattern)); @@ -26,8 +27,9 @@ public RegexMarkerPatternNode(@NotNull String expected, @NotNull String pattern) /** * Constructor of the JSON regex marker pattern node. + * * @param expected The string representation of the expected JSON regex marker pattern. - * @param pattern The regex pattern to match. + * @param pattern The regex pattern to match. */ public RegexMarkerPatternNode(@NotNull String expected, @NotNull Pattern pattern) { super(expected); diff --git a/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/TypeMarkerPatternNode.java b/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/TypeMarkerPatternNode.java index 7e4d7cd..c76011e 100644 --- a/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/TypeMarkerPatternNode.java +++ b/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/TypeMarkerPatternNode.java @@ -2,9 +2,9 @@ import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.node.JsonNodeType; -import io.github.orangain.jsonmatch.pattern.JsonMatchErrorDetail; import io.github.orangain.jsonmatch.json.JsonPath; import io.github.orangain.jsonmatch.json.JsonUtil; +import io.github.orangain.jsonmatch.pattern.JsonMatchErrorDetail; import io.github.orangain.jsonmatch.pattern.ValuePatternNode; import org.jetbrains.annotations.NotNull; @@ -36,9 +36,10 @@ public class TypeMarkerPatternNode extends ValuePatternNode { /** * Constructor of the JSON type marker pattern node. - * @param expected The string representation of the expected JSON type marker pattern. + * + * @param expected The string representation of the expected JSON type marker pattern. * @param expectedNodeType The expected JSON node type. - * @param reasonOnError The reason for the error when the actual node does not match the expected node type. + * @param reasonOnError The reason for the error when the actual node does not match the expected node type. */ public TypeMarkerPatternNode(@NotNull String expected, JsonNodeType expectedNodeType, @NotNull String reasonOnError) { super(expected); diff --git a/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/UUIDMarkerPatternNode.java b/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/UUIDMarkerPatternNode.java index ac6c14a..a3d0613 100644 --- a/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/UUIDMarkerPatternNode.java +++ b/src/main/java/io/github/orangain/jsonmatch/pattern/valuemarker/UUIDMarkerPatternNode.java @@ -1,9 +1,9 @@ package io.github.orangain.jsonmatch.pattern.valuemarker; import com.fasterxml.jackson.databind.JsonNode; -import io.github.orangain.jsonmatch.pattern.JsonMatchErrorDetail; import io.github.orangain.jsonmatch.json.JsonPath; import io.github.orangain.jsonmatch.json.JsonUtil; +import io.github.orangain.jsonmatch.pattern.JsonMatchErrorDetail; import io.github.orangain.jsonmatch.pattern.ValuePatternNode; import org.jetbrains.annotations.NotNull; @@ -18,6 +18,7 @@ public class UUIDMarkerPatternNode extends ValuePatternNode { /** * Constructor of the JSON UUID marker pattern node. + * * @param expected The string representation of the expected JSON UUID marker pattern. */ public UUIDMarkerPatternNode(@NotNull String expected) { @@ -26,6 +27,7 @@ public UUIDMarkerPatternNode(@NotNull String expected) { /** * Get the singleton instance of the JSON UUID marker pattern node. + * * @return The singleton instance of the JSON UUID marker pattern node. */ public static UUIDMarkerPatternNode getInstance() {