Skip to content

Commit

Permalink
refined javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
overheadhunter committed Oct 8, 2021
1 parent 6b78f37 commit 6fd93ef
Showing 1 changed file with 4 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ default void storePassphrase(String key, String displayName, CharSequence passph
}

/**
* @param key Unique key previously used while {@link #storePassphrase(String, CharSequence) storing a passphrase}.
* @param key Unique key previously used while {@link #storePassphrase(String, String, CharSequence)} storing a passphrase}.
* @return The stored passphrase for the given key or <code>null</code> if no value for the given key could be found.
* @throws KeychainAccessException If loading the password failed
*/
Expand All @@ -47,15 +47,15 @@ default void storePassphrase(String key, String displayName, CharSequence passph
/**
* Deletes a passphrase with a given key.
*
* @param key Unique key previously used while {@link #storePassphrase(String, CharSequence) storing a passphrase}.
* @param key Unique key previously used while {@link #storePassphrase(String, String, CharSequence)} storing a passphrase}.
* @throws KeychainAccessException If deleting the password failed
*/
void deletePassphrase(String key) throws KeychainAccessException;

/**
* Updates a passphrase with a given key. Noop, if there is no item for the given key.
*
* @param key Unique key previously used while {@link #storePassphrase(String, CharSequence) storing a passphrase}.
* @param key Unique key previously used while {@link #storePassphrase(String, String, CharSequence)} storing a passphrase}.
* @param passphrase The secret to be updated in this keychain.
* @throws KeychainAccessException If changing the password failed
* @deprecated Please use {@link #changePassphrase(String, String, CharSequence)} instead
Expand All @@ -66,7 +66,7 @@ default void storePassphrase(String key, String displayName, CharSequence passph
/**
* Updates a passphrase with a given key and stores a name for that key. Noop, if there is no item for the given key.
*
* @param key Unique key previously used while {@link #storePassphrase(String, CharSequence) storing a passphrase}.
* @param key Unique key previously used while {@link #storePassphrase(String, String, CharSequence)} storing a passphrase}.
* @param displayName The according name to the key. That's the name of the vault displayed in the UI.
* It's passed to the keychain as an additional information about the vault besides the key.
* The parameter does not need to be unique or be checked by the keychain.
Expand Down

0 comments on commit 6fd93ef

Please sign in to comment.