Fix Javadoc warnings.
This commit is contained in:
@@ -38,6 +38,7 @@ public interface CredHubOperations {
|
||||
* value.
|
||||
*
|
||||
* @param credentialRequest the credential to write to CredHub; must not be {@literal null}
|
||||
* @param <T> the credential implementation type
|
||||
* @return the details of the written credential
|
||||
*/
|
||||
<T> CredentialDetails<T> write(final CredentialRequest<T> credentialRequest);
|
||||
@@ -48,6 +49,8 @@ public interface CredHubOperations {
|
||||
*
|
||||
* @param parametersRequest the parameters of the new credential to generate in CredHub;
|
||||
* must not be {@literal null}
|
||||
* @param <T> the credential implementation type
|
||||
* @param <P> the credential parameter implementation type
|
||||
* @return the details of the generated credential
|
||||
*/
|
||||
<T, P> CredentialDetails<T> generate(ParametersRequest<P> parametersRequest);
|
||||
@@ -57,6 +60,7 @@ public interface CredHubOperations {
|
||||
*
|
||||
* @param id the ID of the credential; must not be {@literal null}
|
||||
* @param credentialType the type of the credential to be retrieved; must not be {@literal null}
|
||||
* @param <T> the credential implementation type
|
||||
* @return the details of the retrieved credential
|
||||
*/
|
||||
<T> CredentialDetails<T> getById(final String id, Class<T> credentialType);
|
||||
@@ -67,6 +71,8 @@ public interface CredHubOperations {
|
||||
* including historical values.
|
||||
*
|
||||
* @param name the name of the credential; must not be {@literal null}
|
||||
* @param credentialType the type of credential expected to be returned
|
||||
* @param <T> the credential implementation type
|
||||
* @return the details of the retrieved credential, including history
|
||||
*/
|
||||
<T> List<CredentialDetails<T>> getByName(final String name, Class<T> credentialType);
|
||||
@@ -77,6 +83,8 @@ public interface CredHubOperations {
|
||||
* including historical values.
|
||||
*
|
||||
* @param name the name of the credential; must not be {@literal null}
|
||||
* @param credentialType the type of credential expected to be returned
|
||||
* @param <T> the credential implementation type
|
||||
* @return the details of the retrieved credential, including history
|
||||
*/
|
||||
<T> List<CredentialDetails<T>> getByName(final CredentialName name, Class<T> credentialType);
|
||||
@@ -186,6 +194,7 @@ public interface CredHubOperations {
|
||||
* by other methods.
|
||||
*
|
||||
* @param callback wrapper for the callback method
|
||||
* @param <T> the credential implementation type
|
||||
* @return the return value from the callback method
|
||||
*/
|
||||
<T> T doWithRest(RestOperationsCallback<T> callback);
|
||||
|
||||
@@ -36,6 +36,8 @@ public class CredentialRequest<T> extends CredHubRequest {
|
||||
|
||||
/**
|
||||
* Initialize a {@link CredentialRequest}.
|
||||
*
|
||||
* @param type the credential implementation type
|
||||
*/
|
||||
protected CredentialRequest(CredentialType type) {
|
||||
this.credentialType = type;
|
||||
|
||||
@@ -25,6 +25,7 @@ import java.util.Map;
|
||||
*
|
||||
* @author Scott Frederick
|
||||
*/
|
||||
@SuppressWarnings("javadoc")
|
||||
public class JsonCredential extends HashMap<String, Object> {
|
||||
/**
|
||||
* @see HashMap#HashMap()
|
||||
@@ -35,6 +36,8 @@ public class JsonCredential extends HashMap<String, Object> {
|
||||
|
||||
/**
|
||||
* @see HashMap#HashMap(int)
|
||||
*
|
||||
* @param initialCapacity the initial capacity
|
||||
*/
|
||||
public JsonCredential(int initialCapacity) {
|
||||
super(initialCapacity);
|
||||
@@ -42,6 +45,9 @@ public class JsonCredential extends HashMap<String, Object> {
|
||||
|
||||
/**
|
||||
* @see HashMap#HashMap(int, float)
|
||||
*
|
||||
* @param initialCapacity the initial capacity
|
||||
* @param loadFactor the load factor
|
||||
*/
|
||||
public JsonCredential(int initialCapacity, float loadFactor) {
|
||||
super(initialCapacity, loadFactor);
|
||||
@@ -49,6 +55,8 @@ public class JsonCredential extends HashMap<String, Object> {
|
||||
|
||||
/**
|
||||
* @see HashMap#HashMap(Map)
|
||||
*
|
||||
* @param m the map whose mappings are to be placed in this map
|
||||
*/
|
||||
public JsonCredential(Map<? extends String, ?> m) {
|
||||
super(m);
|
||||
|
||||
Reference in New Issue
Block a user