Skip to content

Commit

Permalink
Review commit:
Browse files Browse the repository at this point in the history
- extend javadoc
- fixed typo in exception description

Signed-off-by: Stefan Maute <stefan.maute@bosch.io>
  • Loading branch information
Stefan Maute committed Sep 22, 2021
1 parent f090f8f commit 5a05283
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ and do not exist without this Thing.
## Feature ID
Within a Thing each Feature is identified by a unique string - the so called Feature ID.
A Feature ID often needs to be set in the path of a HTTP request. Due to this fact we strongly recommend to use a
restricted set of characters (e.g. those for
[Uniform Resource Identifiers (URI)](https://www.ietf.org/rfc/rfc3986.txt)).
restricted set of characters (e.g. those for [Uniform Resource Identifiers (URI)](https://www.ietf.org/rfc/rfc3986.txt)).

## Feature properties

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ public interface DefinitionIdentifier extends CharSequence {
/**
* Returns the optional URL of this Identifier - if this is present, the {@code namespace}, {@code name} and
* {@code version} strings of the definition are empty.
* @return
* @return the optional URL.
* @since 2.1.0
*/
Optional<URL> getUrl();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ public final class DefinitionIdentifierInvalidException extends DittoRuntimeExce
private static final String MESSAGE_TEMPLATE = "Definition identifier <{0}> is invalid!";

private static final String DEFAULT_DESCRIPTION = "An identifier string is expected to have the structure " +
"'namespace:name:version' where each segment must contain at least one char of [_a-zA-Z0-9\\-.] OR is " +
"must be a valid HTTP(s) URL.";
"'namespace:name:version' where each segment must contain at least one char of [_a-zA-Z0-9\\-.] " +
"OR it must be a valid HTTP(s) URL.";

private static final long serialVersionUID = -5652551484675928573L;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,4 +133,5 @@ public CharSequence subSequence(final int start, final int end) {
public String toString() {
return delegate.toString();
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -97,4 +97,5 @@ public boolean equals(final Object obj) {
}
return obj != null && getClass() == obj.getClass();
}

}

0 comments on commit 5a05283

Please sign in to comment.