diff options
author | Andreas Fitzek <andreas.fitzek@iaik.tugraz.at> | 2014-02-05 09:21:35 +0100 |
---|---|---|
committer | Andreas Fitzek <andreas.fitzek@iaik.tugraz.at> | 2014-02-05 09:21:35 +0100 |
commit | 27fb69688a5de7e291ce5a2fd348becb1a722ad5 (patch) | |
tree | f7228da23b421bd3f50ced92485259090963119b /pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/Configuration.java | |
parent | 87c9269152f8c631123525b796cf07dc0cca7398 (diff) | |
download | pdf-as-4-27fb69688a5de7e291ce5a2fd348becb1a722ad5.tar.gz pdf-as-4-27fb69688a5de7e291ce5a2fd348becb1a722ad5.tar.bz2 pdf-as-4-27fb69688a5de7e291ce5a2fd348becb1a722ad5.zip |
Javadoc for public API
Diffstat (limited to 'pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/Configuration.java')
-rw-r--r-- | pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/Configuration.java | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/Configuration.java b/pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/Configuration.java index 89acc747..d2f00a59 100644 --- a/pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/Configuration.java +++ b/pdf-as-lib/src/main/java/at/gv/egiz/pdfas/lib/api/Configuration.java @@ -1,7 +1,31 @@ package at.gv.egiz.pdfas.lib.api; +/** + * Configuration interface + * + * This interface is used to configure one PDF-AS run. It contains the configuration values + * from the configuration file. Use this interface to override properties during runtime. + */ public interface Configuration { + + /** + * Gets a specific Value + * @param key The configuration key + * @return The configured value + */ public String getValue(String key); + + /** + * Is the configuration key set + * @param key The configuration key + * @return true | false + */ public boolean hasValue(String key); + + /** + * Sets or overrides a configuration value + * @param key The configuration key + * @param value The configuration value + */ public void setValue(String key, String value); } |