zhdev/oblak
1
0
Fork 0
Code Issues Pull requests Activity

Improve nullability annotations on generics in CommandContext (#405)

Browse source
This commit is contained in:
Jason 2022-11-23 15:45:50 -07:00
parent 087fa0df2d
commit 1694df732d
1 changed files with 31 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

62
cloud-core/src/main/java/cloud/commandframework/context/CommandContext.java
View file

@ -200,7 +200,7 @@ public class CommandContext<C> {
* @param value Value * @param value Value
* @param <T> Value type * @param <T> Value type
*/ */
public <T> void store(final @NonNull String key, final @NonNull T value) { public <T extends @NonNull Object> void store(final @NonNull String key, final T value) {
this.internalStorage.put(SimpleCloudKey.of(key), value); this.internalStorage.put(SimpleCloudKey.of(key), value);
} }
@ -212,7 +212,7 @@ public class CommandContext<C> {
* @param value Value * @param value Value
* @param <T> Value type * @param <T> Value type
*/ */
public <T> void store(final @NonNull CloudKey<T> key, final @NonNull T value) { public <T extends @NonNull Object> void store(final @NonNull CloudKey<T> key, final T value) {
this.internalStorage.put(key, value); this.internalStorage.put(key, value);
} }
@ -224,7 +224,7 @@ public class CommandContext<C> {
* @param value Value * @param value Value
* @param <T> Value type * @param <T> Value type
*/ */
public <T> void store(final @NonNull CommandArgument<C, T> keyHolder, final @NonNull T value) { public <T extends @NonNull Object> void store(final @NonNull CommandArgument<C, T> keyHolder, final T value) {
this.store((CloudKeyHolder<T>) keyHolder, value); this.store((CloudKeyHolder<T>) keyHolder, value);
} }
@ -238,7 +238,7 @@ public class CommandContext<C> {
* @since 1.4.0 * @since 1.4.0
*/ */
@API(status = API.Status.STABLE, since = "1.4.0") @API(status = API.Status.STABLE, since = "1.4.0")
public <T> void store(final @NonNull CloudKeyHolder<T> keyHolder, final @NonNull T value) { public <T extends @NonNull Object> void store(final @NonNull CloudKeyHolder<T> keyHolder, final T value) {
this.internalStorage.put(keyHolder.getKey(), value); this.internalStorage.put(keyHolder.getKey(), value);
} }
@ -327,7 +327,7 @@ public class CommandContext<C> {
* @param <T> Value type * @param <T> Value type
* @return Value * @return Value
*/ */
public <T> @NonNull Optional<T> getOptional(final @NonNull String key) { public <T extends @NonNull Object> @NonNull Optional<T> getOptional(final @NonNull String key) {
final Object value = this.internalStorage.get(SimpleCloudKey.of(key)); final Object value = this.internalStorage.get(SimpleCloudKey.of(key));
if (value != null) { if (value != null) {
@SuppressWarnings("unchecked") final T castedValue = (T) value; @SuppressWarnings("unchecked") final T castedValue = (T) value;
@ -347,7 +347,7 @@ public class CommandContext<C> {
* @since 1.4.0 * @since 1.4.0
*/ */
@API(status = API.Status.STABLE, since = "1.4.0") @API(status = API.Status.STABLE, since = "1.4.0")
public <T> @NonNull Optional<T> getOptional(final @NonNull CloudKey<T> key) { public <T extends @NonNull Object> @NonNull Optional<T> getOptional(final @NonNull CloudKey<T> key) {
final Object value = this.internalStorage.get(key); final Object value = this.internalStorage.get(key);
if (value != null) { if (value != null) {
@SuppressWarnings("unchecked") final T castedValue = (T) value; @SuppressWarnings("unchecked") final T castedValue = (T) value;
@ -366,7 +366,7 @@ public class CommandContext<C> {
* @return Value * @return Value
*/ */
@SuppressWarnings("unused") @SuppressWarnings("unused")
public <T> @NonNull Optional<T> getOptional(final @NonNull CommandArgument<C, T> keyHolder) { public <T extends @NonNull Object> @NonNull Optional<T> getOptional(final @NonNull CommandArgument<C, T> keyHolder) {
return this.getOptional((CloudKeyHolder<T>) keyHolder); return this.getOptional((CloudKeyHolder<T>) keyHolder);
} }
@ -381,7 +381,7 @@ public class CommandContext<C> {
*/ */
@SuppressWarnings("unused") @SuppressWarnings("unused")
@API(status = API.Status.STABLE, since = "1.4.0") @API(status = API.Status.STABLE, since = "1.4.0")
public <T> @NonNull Optional<T> getOptional(final @NonNull CloudKeyHolder<T> keyHolder) { public <T extends @NonNull Object> @NonNull Optional<T> getOptional(final @NonNull CloudKeyHolder<T> keyHolder) {
final Object value = this.internalStorage.get(keyHolder.getKey()); final Object value = this.internalStorage.get(keyHolder.getKey());
if (value != null) { if (value != null) {
@SuppressWarnings("unchecked") final T castedValue = (T) value; @SuppressWarnings("unchecked") final T castedValue = (T) value;
@ -412,7 +412,7 @@ public class CommandContext<C> {
} }
/** /**
* Get a required argument from the context. This will thrown an exception * Get a required argument from the context. This will throw an exception
* if there's no value associated with the given key * if there's no value associated with the given key
* *
* @param key Argument key * @param key Argument key
@ -421,7 +421,7 @@ public class CommandContext<C> {
* @throws NullPointerException If no such argument is stored * @throws NullPointerException If no such argument is stored
*/ */
@SuppressWarnings({"unchecked", "TypeParameterUnusedInFormals"}) @SuppressWarnings({"unchecked", "TypeParameterUnusedInFormals"})
public <T> @NonNull T get(final @NonNull String key) { public <T extends @NonNull Object> T get(final @NonNull String key) {
final Object value = this.internalStorage.get(SimpleCloudKey.of(key)); final Object value = this.internalStorage.get(SimpleCloudKey.of(key));
if (value == null) { if (value == null) {
throw new NullPointerException("No such object stored in the context: " + key); throw new NullPointerException("No such object stored in the context: " + key);
@ -430,7 +430,7 @@ public class CommandContext<C> {
} }
/** /**
* Get a required argument from the context. This will thrown an exception * Get a required argument from the context. This will throw an exception
* if there's no value associated with the given key * if there's no value associated with the given key
* *
* @param key Argument key * @param key Argument key
@ -441,7 +441,7 @@ public class CommandContext<C> {
*/ */
@SuppressWarnings({"unchecked", "TypeParameterUnusedInFormals"}) @SuppressWarnings({"unchecked", "TypeParameterUnusedInFormals"})
@API(status = API.Status.STABLE, since = "1.4.0") @API(status = API.Status.STABLE, since = "1.4.0")
public <T> @NonNull T get(final @NonNull CloudKey<T> key) { public <T extends @NonNull Object> T get(final @NonNull CloudKey<T> key) {
final Object value = this.internalStorage.get(key); final Object value = this.internalStorage.get(key);
if (value == null) { if (value == null) {
throw new NullPointerException("No such object stored in the context: " + key); throw new NullPointerException("No such object stored in the context: " + key);
@ -450,7 +450,7 @@ public class CommandContext<C> {
} }
/** /**
* Get a required argument from the context. This will thrown an exception * Get a required argument from the context. This will throw an exception
* if there's no value associated with the given argument * if there's no value associated with the given argument
* *
* @param keyHolder Holder of the identifying key * @param keyHolder Holder of the identifying key
@ -458,12 +458,12 @@ public class CommandContext<C> {
* @return Stored value * @return Stored value
* @throws NullPointerException If no such value is stored * @throws NullPointerException If no such value is stored
*/ */
public <T> @NonNull T get(final @NonNull CommandArgument<C, T> keyHolder) { public <T extends @NonNull Object> T get(final @NonNull CommandArgument<C, T> keyHolder) {
return this.get(keyHolder.getKey()); return this.get(keyHolder.getKey());
} }
/** /**
* Get a required argument from the context. This will thrown an exception * Get a required argument from the context. This will throw an exception
* if there's no value associated with the given argument * if there's no value associated with the given argument
* *
* @param keyHolder Holder of the identifying key * @param keyHolder Holder of the identifying key
@ -473,7 +473,7 @@ public class CommandContext<C> {
* @since 1.4.0 * @since 1.4.0
*/ */
@API(status = API.Status.STABLE, since = "1.4.0") @API(status = API.Status.STABLE, since = "1.4.0")
public <T> @NonNull T get(final @NonNull CloudKeyHolder<T> keyHolder) { public <T extends @NonNull Object> T get(final @NonNull CloudKeyHolder<T> keyHolder) {
return this.get(keyHolder.getKey()); return this.get(keyHolder.getKey());
} }
@ -485,9 +485,9 @@ public class CommandContext<C> {
* @param <T> Argument type * @param <T> Argument type
* @return Stored value, or supplied default value * @return Stored value, or supplied default value
*/ */
public <T> @Nullable T getOrDefault( public <T> T getOrDefault(
final @NonNull CommandArgument<C, T> argument, final @NonNull CommandArgument<C, @NonNull T> argument,
final @Nullable T defaultValue final T defaultValue
) { ) {
return this.<T>getOptional(argument.getName()).orElse(defaultValue); return this.<T>getOptional(argument.getName()).orElse(defaultValue);
} }
@ -500,11 +500,11 @@ public class CommandContext<C> {
* @param <T> Argument type * @param <T> Argument type
* @return Argument, or supplied default value * @return Argument, or supplied default value
*/ */
public <T> @Nullable T getOrDefault( public <T> T getOrDefault(
final @NonNull String key, final @NonNull String key,
final @Nullable T defaultValue final T defaultValue
) { ) {
return this.<T>getOptional(key).orElse(defaultValue); return this.<@NonNull T>getOptional(key).orElse(defaultValue);
} }
/** /**
@ -517,9 +517,9 @@ public class CommandContext<C> {
* @since 1.4.0 * @since 1.4.0
*/ */
@API(status = API.Status.STABLE, since = "1.4.0") @API(status = API.Status.STABLE, since = "1.4.0")
public <T> @Nullable T getOrDefault( public <T> T getOrDefault(
final @NonNull CloudKey<T> key, final @NonNull CloudKey<@NonNull T> key,
final @Nullable T defaultValue final T defaultValue
) { ) {
return this.getOptional(key).orElse(defaultValue); return this.getOptional(key).orElse(defaultValue);
} }
@ -534,11 +534,11 @@ public class CommandContext<C> {
* @since 1.2.0 * @since 1.2.0
*/ */
@API(status = API.Status.STABLE, since = "1.2.0") @API(status = API.Status.STABLE, since = "1.2.0")
public <T> @Nullable T getOrSupplyDefault( public <T> T getOrSupplyDefault(
final @NonNull String key, final @NonNull String key,
final @NonNull Supplier<@Nullable T> defaultSupplier final @NonNull Supplier<T> defaultSupplier
) { ) {
return this.<T>getOptional(key).orElseGet(defaultSupplier); return this.<@NonNull T>getOptional(key).orElseGet(defaultSupplier);
} }
/** /**
@ -551,9 +551,9 @@ public class CommandContext<C> {
* @since 1.4.0 * @since 1.4.0
*/ */
@API(status = API.Status.STABLE, since = "1.4.0") @API(status = API.Status.STABLE, since = "1.4.0")
public <T> @Nullable T getOrSupplyDefault( public <T> T getOrSupplyDefault(
final @NonNull CloudKey<T> key, final @NonNull CloudKey<@NonNull T> key,
final @NonNull Supplier<@Nullable T> defaultSupplier final @NonNull Supplier<T> defaultSupplier
) { ) {
return this.getOptional(key).orElseGet(defaultSupplier); return this.getOptional(key).orElseGet(defaultSupplier);
} }