Corrects issues reported by javadoc plugin

This commit is contained in:
David O'Sullivan
2022-12-22 17:49:55 +00:00
parent d100e81d47
commit e300147c7a
3 changed files with 13 additions and 1 deletions

View File

@@ -138,7 +138,11 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>${maven-javadoc-plugin.version}</version>
<executions>
<configuration>
<quiet>true</quiet>
<source>1.8</source>
</configuration>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>

View File

@@ -57,6 +57,7 @@ public final class Binding {
/**
* Creates a new {@code Binding} instance using the specified file system root.
* @param path the path to the {@code Binding}.
*/
public Binding(Path path) {
this(path.getFileName().toString(), path, createSecretMap(path));
@@ -140,6 +141,7 @@ public final class Binding {
/**
* Returns the name of the binding.
* @return the name of the binding
*/
public String getName() {
return name;
@@ -147,6 +149,7 @@ public final class Binding {
/**
* Returns the path of the binding.
* @return the path of the binding
*/
public Path getPath() {
return path;
@@ -154,6 +157,7 @@ public final class Binding {
/**
* Returns the secret of the binding.
* @return a Map of the secret of the binding
*/
public Map<String, String> getSecret() {
return Collections.unmodifiableMap(secret);
@@ -161,6 +165,7 @@ public final class Binding {
/**
* Returns the type of the binding.
* @return the type of the binding
*/
public String getType() {
return type;
@@ -168,6 +173,7 @@ public final class Binding {
/**
* Returns the provider of the binding.
* @return the provider of the binding
*/
@Nullable
public String getProvider() {
@@ -178,6 +184,7 @@ public final class Binding {
* Returns the {@link Path} to a secret file on disk.
*
* @param name the name of the secret key.
* @return the {@link Path} to a secret file on disk.
*/
public Path getSecretFilePath(String name) {
for (String d : Arrays.asList("metadata", "secret")) {

View File

@@ -112,6 +112,7 @@ public final class Bindings {
/**
* Returns all the {@link Binding}s that were found during construction.
* @return all the {@link Binding}s that were found during construction.
*/
public List<Binding> getBindings() {
return bindings;