From bee76beff1dcbd1bd318433725310fd8df6c2935 Mon Sep 17 00:00:00 2001 From: Mark Paluch Date: Thu, 19 Oct 2017 08:24:48 +0200 Subject: [PATCH] Polishing. Fix javadoc links. See gh-125. --- .../vault/core/env/LeaseAwareVaultPropertySource.java | 2 +- .../vault/core/env/VaultPropertySource.java | 2 +- .../vault/core/lease/SecretLeaseContainer.java | 2 +- .../vault/repository/convert/VaultTypeMapper.java | 4 ++-- .../vault/repository/query/VaultQuery.java | 2 +- .../org/springframework/vault/support/AbstractResult.java | 8 ++++---- .../vault/support/VaultTransitKeyCreationRequest.java | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/spring-vault-core/src/main/java/org/springframework/vault/core/env/LeaseAwareVaultPropertySource.java b/spring-vault-core/src/main/java/org/springframework/vault/core/env/LeaseAwareVaultPropertySource.java index d23f13d8..964a6f63 100644 --- a/spring-vault-core/src/main/java/org/springframework/vault/core/env/LeaseAwareVaultPropertySource.java +++ b/spring-vault-core/src/main/java/org/springframework/vault/core/env/LeaseAwareVaultPropertySource.java @@ -208,7 +208,7 @@ public class LeaseAwareVaultPropertySource * map. * * @param data the map - * @return + * @return the flattened map. */ protected Map toStringMap(Map data) { return JsonMapFlattener.flatten(data); diff --git a/spring-vault-core/src/main/java/org/springframework/vault/core/env/VaultPropertySource.java b/spring-vault-core/src/main/java/org/springframework/vault/core/env/VaultPropertySource.java index 8d2fac2f..d06cc675 100644 --- a/spring-vault-core/src/main/java/org/springframework/vault/core/env/VaultPropertySource.java +++ b/spring-vault-core/src/main/java/org/springframework/vault/core/env/VaultPropertySource.java @@ -184,7 +184,7 @@ public class VaultPropertySource extends EnumerablePropertySource toStringMap(Map data) { return JsonMapFlattener.flatten(data); diff --git a/spring-vault-core/src/main/java/org/springframework/vault/core/lease/SecretLeaseContainer.java b/spring-vault-core/src/main/java/org/springframework/vault/core/lease/SecretLeaseContainer.java index ae8a307e..deb07356 100644 --- a/spring-vault-core/src/main/java/org/springframework/vault/core/lease/SecretLeaseContainer.java +++ b/spring-vault-core/src/main/java/org/springframework/vault/core/lease/SecretLeaseContainer.java @@ -60,7 +60,7 @@ import org.springframework.web.client.HttpStatusCodeException; /** * Event-based container to request secrets from Vault and renew the associated * {@link Lease}. Secrets can be rotated, depending on the requested - * {@link RequestedSecret.Mode}. + * {@link RequestedSecret#getMode()}. * * Usage example: * diff --git a/spring-vault-core/src/main/java/org/springframework/vault/repository/convert/VaultTypeMapper.java b/spring-vault-core/src/main/java/org/springframework/vault/repository/convert/VaultTypeMapper.java index 6ac9ed41..7b6fefc2 100644 --- a/spring-vault-core/src/main/java/org/springframework/vault/repository/convert/VaultTypeMapper.java +++ b/spring-vault-core/src/main/java/org/springframework/vault/repository/convert/VaultTypeMapper.java @@ -29,9 +29,9 @@ import org.springframework.data.convert.TypeMapper; public interface VaultTypeMapper extends TypeMapper> { /** - * Returns whether the given key is the type key. + * Returns whether the given {@code key} is the type key. * - * @return + * @return {@literal true} if the {@code key} is the type key. */ boolean isTypeKey(String key); } diff --git a/spring-vault-core/src/main/java/org/springframework/vault/repository/query/VaultQuery.java b/spring-vault-core/src/main/java/org/springframework/vault/repository/query/VaultQuery.java index 9a914a38..2275a84a 100644 --- a/spring-vault-core/src/main/java/org/springframework/vault/repository/query/VaultQuery.java +++ b/spring-vault-core/src/main/java/org/springframework/vault/repository/query/VaultQuery.java @@ -96,7 +96,7 @@ public class VaultQuery { * Compose a new {@link VaultQuery} using predicates of {@literal this} and the * {@code other} query using logical {@code AND}. * - * @param other must not be {@literal null}. + * @param predicate must not be {@literal null}. * @return a new composed {@link VaultQuery}. * @see Predicate#and(Predicate) */ diff --git a/spring-vault-core/src/main/java/org/springframework/vault/support/AbstractResult.java b/spring-vault-core/src/main/java/org/springframework/vault/support/AbstractResult.java index 2482f312..104e2fe7 100644 --- a/spring-vault-core/src/main/java/org/springframework/vault/support/AbstractResult.java +++ b/spring-vault-core/src/main/java/org/springframework/vault/support/AbstractResult.java @@ -51,11 +51,11 @@ public abstract class AbstractResult { } /** - * Returns {@link true} if and only if the batch operation was completed successfully. - * Use {@link #getCause()} to obtain the actual exception if the operation completed - * with an error. + * Returns {@literal true} if and only if the batch operation was completed + * successfully. Use {@link #getCause()} to obtain the actual exception if the + * operation completed with an error. * - * @return {@link true} if the batch operation was completed successfully. + * @return {@literal true} if the batch operation was completed successfully. */ public boolean isSuccessful() { return exception == null; diff --git a/spring-vault-core/src/main/java/org/springframework/vault/support/VaultTransitKeyCreationRequest.java b/spring-vault-core/src/main/java/org/springframework/vault/support/VaultTransitKeyCreationRequest.java index 73630a77..ac2bd6ca 100644 --- a/spring-vault-core/src/main/java/org/springframework/vault/support/VaultTransitKeyCreationRequest.java +++ b/spring-vault-core/src/main/java/org/springframework/vault/support/VaultTransitKeyCreationRequest.java @@ -48,7 +48,7 @@ public class VaultTransitKeyCreationRequest { /** * Create a new {@link VaultTransitKeyCreationRequest} specifically for a {@code type} * . - * @param the key type to use, must not be {@literal null} or empty. + * @param type the key type to use, must not be {@literal null} or empty. * @return a new {@link VaultTransitKeyCreationRequest} for the given key {@code type} * . * @since 2.0