PGPainless/cert-d-java
1
0
Fork 0
mirror of https://codeberg.org/PGPainless/cert-d-java.git synced 2025-09-09 03:09:39 +02:00
Code Issues Projects Releases Packages Wiki Activity

Fix javadoc warnings

Browse source
This commit is contained in:
Paul Schaub 2022-04-29 16:31:49 +02:00
parent ce1469948f
commit 27d48824b3
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
7 changed files with 47 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

12
pgp-cert-d-java/src/main/java/pgp/cert_d/FilenameResolver.java
View file

@ -28,7 +28,8 @@ public class FilenameResolver {
*
* @param fingerprint fingerprint
* @return absolute certificate file location
* @throws BadNameException
*
* @throws BadNameException if the given fingerprint string is not a fingerprint
*/
public File getCertFileByFingerprint(String fingerprint) throws BadNameException {
if (!isFingerprint(fingerprint)) {
@ -41,6 +42,15 @@ public class FilenameResolver {
return file;
}
/**
* Calculate the file location for the certification addressed using the given special name.
* For known special names, see {@link SpecialNames}.
*
* @param specialName special name (e.g. "trust-root")
* @return absolute certificate file location
*
* @throws BadNameException in case the given special name is not known
*/
public File getCertFileBySpecialName(String specialName) throws BadNameException {
if (!isSpecialName(specialName)) {
throw new BadNameException();

7
pgp-cert-d-java/src/main/java/pgp/cert_d/LockingMechanism.java
View file

@ -11,6 +11,9 @@ public interface LockingMechanism {
/**
* Lock the store for writes.
* Readers can continue to use the store and will always see consistent certs.
*
* @throws IOException in case of an IO error
* @throws InterruptedException if the thread gets interrupted
*/
void lockDirectory() throws IOException, InterruptedException;
@ -19,11 +22,15 @@ public interface LockingMechanism {
* Return false without locking the store in case the store was already locked.
*
* @return true if locking succeeded, false otherwise
*
* @throws IOException in case of an IO error
*/
boolean tryLockDirectory() throws IOException;
/**
* Release the directory write-lock acquired via {@link #lockDirectory()}.
*
* @throws IOException in case of an IO error
*/
void releaseDirectory() throws IOException;