Skip to content

Commit

Permalink
review: adjusted some javadocs
Browse files Browse the repository at this point in the history
* full qualified links to classes removed where not needed

Signed-off-by: Thomas Jaeckle <thomas.jaeckle@bosch-si.com>
  • Loading branch information
thjaeckle committed Dec 6, 2018
1 parent 8be36f3 commit 18d99e4
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
import javax.annotation.concurrent.Immutable;

/**
* This abstract implementation of {@link org.eclipse.ditto.json.JsonFieldDefinition} is meant to be used for all value
* types which are supported by {@link org.eclipse.ditto.json.JsonValue} to make parsing a JsonObject easier and most
* This abstract implementation of {@link JsonFieldDefinition} is meant to be used for all value
* types which are supported by {@link JsonValue} to make parsing a JsonObject easier and most
* notably, type safe.
*
* @param <T> the type of this definition's value type.
Expand Down
8 changes: 4 additions & 4 deletions json/src/main/java/org/eclipse/ditto/json/JsonArray.java
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,14 @@ static JsonArray empty() {

/**
* Returns an instance of {@code JsonArray} which contains the given values.
* This method tries to determine the appropriate {@link org.eclipse.ditto.json.JsonValue}-counterpart for each
* This method tries to determine the appropriate {@link JsonValue}-counterpart for each
* given value.
*
* @param value the mandatory value of the returned JsonArray.
* @param furtherValues further optional values of the returned JsonArray.
* @return the JsonArray.
* @throws NullPointerException if {@code furtherValues} is {@code null}.
* @throws org.eclipse.ditto.json.JsonParseException if either {@code value} or any item of {@code furtherValues}
* @throws JsonParseException if either {@code value} or any item of {@code furtherValues}
* cannot be converted to {@code JsonValue}.
*/
@SuppressWarnings("unchecked")
Expand All @@ -71,13 +71,13 @@ static <T> JsonArray of(@Nullable final T value, final T... furtherValues) {

/**
* Returns an instance of {@code JsonArray} which contains the given values.
* This method tries to determine the appropriate {@link org.eclipse.ditto.json.JsonValue}-counterpart for each
* This method tries to determine the appropriate {@link JsonValue}-counterpart for each
* item of the specified Iterable.
*
* @param values the values of the returned JsonArray. {@code null} items are
* @return the JsonArray.
* @throws NullPointerException if {@code values} is {@code null}.
* @throws org.eclipse.ditto.json.JsonParseException if any item of {@code values} cannot be converted to
* @throws JsonParseException if any item of {@code values} cannot be converted to
* {@code JsonValue}.
*/
static <T> JsonArray of(final Iterable<T> values) {
Expand Down
2 changes: 1 addition & 1 deletion json/src/main/java/org/eclipse/ditto/json/JsonValue.java
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ static JsonValue of(@Nullable final String jsonString) {
* @param value the Java value to be converted to its JsonValue counterpart.
* @param <T> the Java type to be converted.
* @return the appropriate JsonValue.
* @throws org.eclipse.ditto.json.JsonParseException if {@code value} cannot be converted to a valid JSON value.
* @throws JsonParseException if {@code value} cannot be converted to a valid JSON value.
*/
static <T> JsonValue of(@Nullable final T value) {
return JsonFactory.getAppropriateValue(value);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import javax.annotation.concurrent.Immutable;

/**
* This implementation of {@link org.eclipse.ditto.json.JsonFieldDefinition} is meant to be used for all
* This implementation of {@link JsonFieldDefinition} is meant to be used for all
* {@link JsonValue} types to make parsing a JsonObject easier, and most notably, type safe.
*
* A {@code null} value is not mapped to a Java {@code null} but remains a JSON null; thus
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,13 @@ private JsonValueParser() {
* Returns a parser which accepts a String and which uses the given handler for object creation.
* The parsed JsonValue can be obtained from the given handler finally.
*
* @param jsonHandler receives parser events in order to create a {@link org.eclipse.ditto.json.JsonValue}.
* @param jsonHandler receives parser events in order to create a {@link JsonValue}.
* @param <A> the type to be used for parsing JSON arrays.
* @param <O> the type to be used for parsing JSON objects.
* @param <V> the type of the value this handler returns.
* @return the parse Function.
* @throws NullPointerException if {@code jsonHandler} is {@code null}.
* @throws org.eclipse.ditto.json.JsonParseException if the string cannot be parsed.
* @throws JsonParseException if the string cannot be parsed.
* @see DittoJsonHandler#getValue()
*/
public static <A, O, V> Consumer<String> fromString(final DittoJsonHandler<A, O, V> jsonHandler) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
/**
* Ditto JSON is a general purpose JSON library. This package provides the corresponding interfaces as well as
* implementations. There is one central place for obtaining instances of the various interfaces:
* {@link org.eclipse.ditto.json.JsonFactory}. JsonFactory provides only {@code static} methods which means that they
* {@link JsonFactory}. JsonFactory provides only {@code static} methods which means that they
* can be imported statically and by thus make calls concise to assist the readability of your code.
* <p>
* Please note that Ditto JSON is designed for <em>immutability</em>. Therefore each object returned by JsonFactory -
Expand Down

0 comments on commit 18d99e4

Please sign in to comment.