Skip to content

Commit

Permalink
Issue #106 add 'since' annotation
Browse files Browse the repository at this point in the history
Signed-off-by: Joel Bartelheimer <joel.bartelheimer@bosch.io>
  • Loading branch information
jbartelh committed Nov 26, 2021
1 parent c086300 commit 96ed087
Show file tree
Hide file tree
Showing 14 changed files with 14 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
* Normalized in this context means trimmed and converted to lower case.
* Normalization is temporarily conducted by this class for validation only.
*
* @since 2.1.0
* @since 2.3.0
*/
@Immutable
final class DittoChannelValueValidator extends AbstractHeaderValueValidator {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ public enum DittoHeaderDefinition implements HeaderDefinition {
* <p>
* Key: {@code "channel"}, Java type: {@link String}.
* </p>
* @since 2.3.0
*/
CHANNEL("channel", String.class, true, true,
HeaderValueValidators.getDittoChannelValidator()),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ static ValueValidator getMetadataHeadersValidator() {
* Normalization is temporarily conducted by the returned validator for validation only.
*
* @return the validator.
* @since 2.1.0
* @since 2.3.0
*/
static ValueValidator getDittoChannelValidator() {
return DittoChannelValueValidator.getInstance();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public final class Acknowledgement implements CommandResponse<Acknowledgement>,

/**
* The type of {@code Acknowledgement} signals.
* TODO change @since 2.x.x
* @since 2.3.0
*/
public static final String TYPE = "acknowledgement";

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
/**
* Transports a {@link LogEntry} that should be added to the log of a connection with a particular {@code ConnectionId}.
*
* TODO change @since 2.x.x
* @since 2.3.0
*/
@Immutable
public final class AddConnectionLogEntry implements Jsonifiable<JsonObject>, WithConnectionId {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
/**
* Factory for creating instances of {@link LogEntry}.
*
* TODO change @since 2.x.x
* @since 2.3.0
*/
@Immutable
public final class LogEntryFactory {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ default void exception(final ConnectionMonitor.InfoProvider infoProvider) {
*
* @param logEntry the entry to be logged.
* @throws NullPointerException if {@code logEntry} is {@code null}.
* TODO change @since 2.x.x
* @since 2.3.0
*/
void logEntry(LogEntry logEntry);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
/**
* Provides dedicated information about specified {@code Signal} arguments.
*
* TODO change @since 2.x.x
* @since 2.3.0
*/
@Immutable
public final class SignalInformationPoint {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
* If the type of the command or command response is invalid an {@link UnsupportedSignalException} is thrown.
* </p>
* <p>
* TODO change @since 2.x.x
* @since 2.3.0
*/
@Immutable
public final class CommandAndCommandResponseMatchingValidator
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
/**
* Represents the result of validating whether two particular signals are correlated to each other.
*
* TODO change @since 2.x.x
* @since 2.3.0
*/
@Immutable
@SuppressWarnings("java:S1610")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
* <em>Note:</em> This class cannot be used for {@code Acknowledgement} signals.
* </p>
*
* TODO change @since 2.x.x
* @since 2.3.0
*/
@Immutable
public final class SemanticSignalType {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* Thrown to indicate that the application has attempted to convert a CharSequence to a signal type, but that
* CharSequence does not have the appropriate format.
*
* TODO change @since 2.x.x
* @since 2.3.0
*/
public final class SignalTypeFormatException extends Exception {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
/**
* Factory for creating shard region proxy actors.
*
* TODO change @since 2.x.x
* @since 2.3.0
*/
@NotThreadSafe
public final class ShardRegionProxyActorFactory {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ public static Builder newBuilderForPolicyExisting(final ThingId thingId, final P
*
* @param dittoHeaders the headers of the command which resulted in the returned exception.
* @throws NullPointerException if {@code dittoHeaders} is {@code null}.
* TODO change @since 2.x.x
* @since 2.3.0
*/
public static ThingNotCreatableException forLiveChannel(final DittoHeaders dittoHeaders) {
return new Builder()
Expand Down

0 comments on commit 96ed087

Please sign in to comment.