PGPainless/cert-d-java
1
0
Fork 0
mirror of https://codeberg.org/PGPainless/cert-d-java.git synced 2024-12-22 13:47:59 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add documentation to BaseDirectoryProvider

Browse source
This commit is contained in:
Paul Schaub 2022-08-24 14:09:20 +02:00
parent f382189638
commit a956aec5fc
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
pgp-cert-d-java/src/main/java/pgp/cert_d/BaseDirectoryProvider.java
View file

@ -6,6 +6,16 @@ package pgp.cert_d;
import java.io.File;
/**
* Provider class that is responsible for resolving the pgp.cert.d base directory of the system.
* The result can be overwritten by setting the <pre>PGP_CERT_D</pre> environment variable.
* If this variable is not set, the system-specific default directory will be returned.
*
* On Windows systems, this is <pre>%APPDATA%\pgp.cert.d</pre>.
* On Linux systems it is either <pre>$XDG_DATA_HOME/pgp.cert.d</pre> or, if <pre>$XDG_DATA_HOME</pre> is not set,
* it is <pre>$HOME/.local/share/pgp.cert.d</pre>
* On Mac systems it is <pre>$HOME/Library/Application Support/pgp.cert.d</pre>.
*/
public class BaseDirectoryProvider {
public static File getDefaultBaseDir() {