Spring/spring-vault
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix Javadoc warnings.

Browse Source 
Closes gh-475.
This commit is contained in:
Mark Paluch
2019-09-30 14:40:24 +02:00
parent edf170f3af
commit 5214ca174e
12 changed files with 34 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
pom.xml
View File

@@ -1,5 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/maven-v4_0_0.xsd">
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.springframework.vault</groupId>
@@ -39,7 +41,7 @@
<doc.resources>${project.build.directory}/doc-resources</doc.resources>
<!-- To be overridden by individual modules -->
<java-module-name />
<java-module-name/>
</properties>
<inceptionYear>2016</inceptionYear>
@@ -416,6 +418,9 @@
<docfilessubdirs>true</docfilessubdirs>
<doclint>none</doclint>
<links>
<link>
https://docs.spring.io/spring/docs/current/javadoc-api
</link>
<link>
https://docs.spring.io/spring-data/commons/docs/current/api
</link>

7
spring-vault-core/src/main/java/org/springframework/vault/authentication/AppRoleAuthenticationOptions.java
View File

@@ -209,7 +209,7 @@ public class AppRoleAuthenticationOptions {
*
* @param roleId must not be empty or {@literal null}.
* @return {@code this} {@link AppRoleAuthenticationOptionsBuilder}.
* @deprecated since 2.0, use {@link #roleId(RoleId)}.
* @deprecated since 2.0, use {@link #roleId(AppRoleAuthenticationOptions.RoleId)}.
*/
@Deprecated
public AppRoleAuthenticationOptionsBuilder roleId(String roleId) {
@@ -240,7 +240,7 @@ public class AppRoleAuthenticationOptions {
*
* @param secretId must not be empty or {@literal null}.
* @return {@code this} {@link AppRoleAuthenticationOptionsBuilder}.
* @deprecated since 2.0, use {@link #secretId(SecretId)}.
* @deprecated since 2.0, use {@link #secretId(AppRoleAuthenticationOptions.SecretId)}.
*/
@Deprecated
public AppRoleAuthenticationOptionsBuilder secretId(String secretId) {
@@ -288,7 +288,8 @@ public class AppRoleAuthenticationOptions {
* @param initialToken must not be empty or {@literal null}.
* @return {@code this} {@link AppRoleAuthenticationOptionsBuilder}.
* @since 1.1
* @deprecated since 2.0, use {@link #roleId(RoleId)}/{@link #secretId(SecretId)}
* @deprecated since 2.0, use
* {@link #roleId(AppRoleAuthenticationOptions.RoleId)}/{@link #secretId(AppRoleAuthenticationOptions.SecretId)}
* to configure pull mode.
*/
@Deprecated

2
spring-vault-core/src/main/java/org/springframework/vault/client/VaultResponses.java
View File

@@ -142,7 +142,7 @@ public abstract class VaultResponses {
* Obtain the error message from a JSON response.
*
* @param json must not be {@literal null}.
* @return
* @return extracted error string.
*/
@SuppressWarnings("unchecked")
public static String getError(String json) {

3
spring-vault-core/src/main/java/org/springframework/vault/core/VaultKeyValueOperations.java
View File

@@ -31,7 +31,7 @@ import org.springframework.vault.support.VaultResponseSupport;
* @author Mark Paluch
* @since 2.1
* @see VaultVersionedKeyValueOperations
* @see KeyValueBackend
* @see VaultKeyValueOperationsSupport.KeyValueBackend
*/
public interface VaultKeyValueOperations extends VaultKeyValueOperationsSupport {
@@ -59,7 +59,6 @@ public interface VaultKeyValueOperations extends VaultKeyValueOperationsSupport
*
* @param path must not be {@literal null}.
* @param body must not be {@literal null}.
* @return the resulting {@link VaultResponse}.
*/
void put(String path, Object body);
}

2
spring-vault-core/src/main/java/org/springframework/vault/core/env/VaultPropertySourceNotFoundException.java vendored
View File

@@ -23,7 +23,7 @@ import org.springframework.vault.annotation.VaultPropertySource;
*
* @author Mark Paluch
* @since 2.2
* @see VaultPropertySource#ignoreSecretNotFound()
* @see VaultPropertySource#ignoreSecretNotFound
*/
public class VaultPropertySourceNotFoundException extends VaultException {

22
spring-vault-core/src/main/java/org/springframework/vault/repository/convert/MappingVaultConverter.java
View File

@@ -308,9 +308,8 @@ public class MappingVaultConverter extends AbstractVaultConverter {
* @param type the {@link Map} {@link TypeInformation} to be used to unmarshal this
* {@link Map}.
* @param sourceMap must not be {@literal null}
* @return
* @return the converted {@link Map}.
*/
@SuppressWarnings("unchecked")
protected Map<Object, Object> readMap(TypeInformation<?> type,
Map<String, Object> sourceMap) {
@@ -539,7 +538,7 @@ public class MappingVaultConverter extends AbstractVaultConverter {
*
* @param collection must not be {@literal null}.
* @param property must not be {@literal null}.
* @return
* @return the converted {@link List}.
*/
protected List<Object> createCollection(Collection<?> collection,
VaultPersistentProperty property) {
@@ -555,7 +554,7 @@ public class MappingVaultConverter extends AbstractVaultConverter {
* {@literal null}.
* @param type the {@link TypeInformation} to consider or {@literal null} if unknown.
* @param sink the {@link List} to write to.
* @return
* @return the converted {@link List}.
*/
private List<Object> writeCollectionInternal(Collection<?> source,
@Nullable TypeInformation<?> type, List<Object> sink) {
@@ -594,7 +593,7 @@ public class MappingVaultConverter extends AbstractVaultConverter {
*
* @param map must not {@literal null}.
* @param property must not be {@literal null}.
* @return
* @return the converted {@link Map}.
*/
protected Map<String, Object> createMap(Map<Object, Object> map,
VaultPersistentProperty property) {
@@ -613,7 +612,7 @@ public class MappingVaultConverter extends AbstractVaultConverter {
* @param obj must not be {@literal null}.
* @param bson must not be {@literal null}.
* @param propertyType must not be {@literal null}.
* @return
* @return the converted {@link Map}.
*/
protected Map<String, Object> writeMapInternal(Map<Object, Object> obj,
Map<String, Object> bson, TypeInformation<?> propertyType) {
@@ -657,7 +656,7 @@ public class MappingVaultConverter extends AbstractVaultConverter {
* is if the value is not the same as the one given. This is usually the case if you
* store a subtype of the actual declared type of the property.
*
* @param type
* @param type type hint.
* @param value must not be {@literal null}.
* @param accessor must not be {@literal null}.
*/
@@ -678,8 +677,8 @@ public class MappingVaultConverter extends AbstractVaultConverter {
* arbitrary simple Vault type. Returns the converted value if so. If not, we perform
* special enum handling or simply return the value as is.
*
* @param value
* @return
* @param value the value to write.
* @return the converted value. Can be {@literal null}.
*/
@Nullable
private Object getPotentiallyConvertedSimpleWrite(@Nullable Object value) {
@@ -713,8 +712,9 @@ public class MappingVaultConverter extends AbstractVaultConverter {
* {@link Collection} or simply create a single element collection for everything
* else.
*
* @param source
* @return
* @param source the collection object. Can be a {@link Collection}, array or
* singleton object.
* @return the {@code source} as {@link Collection}.
*/
private static Collection<?> asCollection(Object source) {

2
spring-vault-core/src/main/java/org/springframework/vault/security/VaultBytesKeyGenerator.java
View File

@@ -42,7 +42,7 @@ public class VaultBytesKeyGenerator implements BytesKeyGenerator {
private String transitPath;
/**
* Creates a new {@link VaultBytesKeyGenerator} initialized to generate {@link 32}
* Creates a new {@link VaultBytesKeyGenerator} initialized to generate {@code 32}
* random bytes using {@code transit} for transit mount path.
*
* @param vaultOperations must not be {@literal null}.

4
spring-vault-core/src/main/java/org/springframework/vault/support/LeaseStrategy.java
View File

@@ -38,7 +38,7 @@ public interface LeaseStrategy {
/**
* Predefined strategy to drop leases on error.
*
* @return
* @return the drop on error strategy.
*/
static LeaseStrategy dropOnError() {
return error -> true;
@@ -47,7 +47,7 @@ public interface LeaseStrategy {
/**
* Predefined strategy to retain leases on error.
*
* @return
* @return the retain on error strategy.
*/
static LeaseStrategy retainOnError() {
return error -> false;

2
spring-vault-core/src/main/java/org/springframework/vault/support/Policy.java
View File

@@ -485,7 +485,7 @@ public class Policy {
/**
* Build the {@link Rule} object. Requires a configured {@link #path(String)}
* and at least one {@link #capability(Capability)}.
* and at least one {@link #capability(Policy.Capability)}.
*
* @return the new {@link Rule} object.
*/

2
spring-vault-core/src/main/java/org/springframework/vault/support/VaultSignatureVerificationRequest.java
View File

@@ -144,7 +144,7 @@ public class VaultSignatureVerificationRequest {
/**
* Configure the {@link Signature} to be verified. Signature verification requires
* either a {@link Signature} or a {@link #hmac(Hmac)} to be configured. Clears
* any previously configured {@link HMAC}.
* any previously configured {@link #hmac(Hmac)}.
*
* @param signature to be verified, must not be {@literal null}.
* @return {@code this} {@link VaultSignatureVerificationRequestBuilder}.

6
spring-vault-core/src/main/java/org/springframework/vault/support/Versioned.java
View File

@@ -373,10 +373,10 @@ public class Versioned<T> {
}
/**
* Build the {@link Metadata} object. Requires {@link #createdAt(Instant)} and
* {@link #version(Version)} to be set.
* Build the {@link Versioned.Metadata} object. Requires {@link #createdAt(Instant)} and
* {@link #version(Versioned.Version)} to be set.
*
* @return the {@link Metadata} object.
* @return the {@link Versioned.Metadata} object.
*/
public Metadata build() {

2
spring-vault-dependencies/pom.xml
View File

@@ -168,7 +168,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.0.1</version>
<version>3.1.1</version>
<executions>
<execution>
<goals>