summaryrefslogtreecommitdiff
path: root/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui
diff options
context:
space:
mode:
authorThomas <thomas.lenz@egiz.gv.at>2019-12-05 09:52:48 +0100
committerThomas <thomas.lenz@egiz.gv.at>2019-12-05 09:52:48 +0100
commit3fada6cef21c9b16467177d866df778203b51b4d (patch)
tree8fe8ed37b6ee9fe35a1e035ceba6c68808328415 /eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui
parent95b21a826e5d81fdeabcf4673a9e87047edaec9d (diff)
downloadEAAF-Components-3fada6cef21c9b16467177d866df778203b51b4d.tar.gz
EAAF-Components-3fada6cef21c9b16467177d866df778203b51b4d.tar.bz2
EAAF-Components-3fada6cef21c9b16467177d866df778203b51b4d.zip
some code code-style modifications
active code-quality checks!
Diffstat (limited to 'eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui')
-rw-r--r--eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/GroupDefinition.java1
-rw-r--r--eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/IGuiBuilderConfiguration.java1
-rw-r--r--eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/IGuiBuilderConfigurationFactory.java17
-rw-r--r--eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/IGuiFormBuilder.java37
-rw-r--r--eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/IVelocityGuiBuilderConfiguration.java9
-rw-r--r--eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/ModifyableGuiBuilderConfiguration.java21
6 files changed, 44 insertions, 42 deletions
diff --git a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/GroupDefinition.java b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/GroupDefinition.java
index 5fdbe2bb..30491ca2 100644
--- a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/GroupDefinition.java
+++ b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/GroupDefinition.java
@@ -31,4 +31,3 @@ public class GroupDefinition {
}
}
-
diff --git a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/IGuiBuilderConfiguration.java b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/IGuiBuilderConfiguration.java
index 52fa7f45..55197b52 100644
--- a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/IGuiBuilderConfiguration.java
+++ b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/IGuiBuilderConfiguration.java
@@ -29,7 +29,6 @@ import java.util.Map;
*/
public interface IGuiBuilderConfiguration {
-
/**
* Define the name of the template (with suffix) which should be used.
*
diff --git a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/IGuiBuilderConfigurationFactory.java b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/IGuiBuilderConfigurationFactory.java
index b01990af..ed888f87 100644
--- a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/IGuiBuilderConfigurationFactory.java
+++ b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/IGuiBuilderConfigurationFactory.java
@@ -17,11 +17,11 @@
* works that you distribute must include a readable copy of the "NOTICE" text file.
*/
-
package at.gv.egiz.eaaf.core.api.gui;
import java.net.MalformedURLException;
import java.net.URI;
+
import at.gv.egiz.eaaf.core.api.IRequest;
public interface IGuiBuilderConfigurationFactory {
@@ -37,17 +37,18 @@ public interface IGuiBuilderConfigurationFactory {
/**
* Default Velocity based GUI builder configuration.
*
- * <p>
- * Manly used for SAML2 POST-Binding
- * </p>
+ * <p>
+ * Manly used for SAML2 POST-Binding
+ * </p>
*
- * @param pendingReq Current processed pending-request but never null
- * @param viewName Name of the default template (with suffix) but never null
+ * @param pendingReq Current processed pending-request but never null
+ * @param viewName Name of the default template (with suffix) but
+ * never null
* @param configRootContextDir Path to configuration root directory
* @return GUI builder configuration
* @throws MalformedURLException If configRootContextDir is not a valid URI
*/
- IVelocityGuiBuilderConfiguration getSpSpecificSaml2PostConfiguration(IRequest pendingReq,
- String viewName, URI configRootContextDir) throws MalformedURLException;
+ IVelocityGuiBuilderConfiguration getSpSpecificSaml2PostConfiguration(IRequest pendingReq, String viewName,
+ URI configRootContextDir) throws MalformedURLException;
}
diff --git a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/IGuiFormBuilder.java b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/IGuiFormBuilder.java
index f0811021..d376d17b 100644
--- a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/IGuiFormBuilder.java
+++ b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/IGuiFormBuilder.java
@@ -21,6 +21,7 @@ package at.gv.egiz.eaaf.core.api.gui;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
+
import at.gv.egiz.eaaf.core.exceptions.GuiBuildException;
/**
@@ -31,40 +32,38 @@ import at.gv.egiz.eaaf.core.exceptions.GuiBuildException;
*/
public interface IGuiFormBuilder {
-
-
/**
- * Parse a GUI template, with parameters into a http servlet-response and use the default
- * http-response content-type. <br>
+ * Parse a GUI template, with parameters into a http servlet-response and use
+ * the default http-response content-type. <br>
* <br>
- * The parser use the <code>VelocityEngine</code> as internal template evaluator.
+ * The parser use the <code>VelocityEngine</code> as internal template
+ * evaluator.
*
- * @param httpReq http-request object
- * @param httpResp http-response object
- * @param config Configuration object
+ * @param httpReq http-request object
+ * @param httpResp http-response object
+ * @param config Configuration object
* @param loggerName String, which should be used from logger
*
* @throws GuiBuildException in case of an error
*/
- void build(HttpServletRequest httpReq, HttpServletResponse httpResp,
- IGuiBuilderConfiguration config, String loggerName) throws GuiBuildException;
+ void build(HttpServletRequest httpReq, HttpServletResponse httpResp, IGuiBuilderConfiguration config,
+ String loggerName) throws GuiBuildException;
/**
* Parse a GUI template, with parameters into a http servlet-response. <br>
* <br>
- * The parser use the <code>VelocityEngine</code> as internal template evaluator.
+ * The parser use the <code>VelocityEngine</code> as internal template
+ * evaluator.
*
- * @param httpReq http-request object
- * @param httpResp http-response object
- * @param config Configuration object
+ * @param httpReq http-request object
+ * @param httpResp http-response object
+ * @param config Configuration object
* @param contentType http-response content-type, which should be set
- * @param loggerName String, which should be used from logger
+ * @param loggerName String, which should be used from logger
*
* @throws GuiBuildException in case of an error
*/
- void build(HttpServletRequest httpReq, HttpServletResponse httpResp,
- IGuiBuilderConfiguration config, String contentType, String loggerName)
- throws GuiBuildException;
-
+ void build(HttpServletRequest httpReq, HttpServletResponse httpResp, IGuiBuilderConfiguration config,
+ String contentType, String loggerName) throws GuiBuildException;
}
diff --git a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/IVelocityGuiBuilderConfiguration.java b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/IVelocityGuiBuilderConfiguration.java
index 151f1eeb..47de65ff 100644
--- a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/IVelocityGuiBuilderConfiguration.java
+++ b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/IVelocityGuiBuilderConfiguration.java
@@ -4,8 +4,9 @@ import java.io.InputStream;
public interface IVelocityGuiBuilderConfiguration extends IGuiBuilderConfiguration {
/**
- * Get a specific classpath template-directory prefix, which is used to load a template from
- * classpath by using <code>ClassLoader.getResourceAsStream(...)</code>.
+ * Get a specific classpath template-directory prefix, which is used to load a
+ * template from classpath by using
+ * <code>ClassLoader.getResourceAsStream(...)</code>.
*
* @return Classpath directory, or null if the default directory should be used
*/
@@ -15,8 +16,8 @@ public interface IVelocityGuiBuilderConfiguration extends IGuiBuilderConfigurati
* Get the GUI template with a specific name.
*
* @param viewName Name of the template
- * @return Tempate as <code>InputStream</code>, or null if default getTemplate method should be
- * used
+ * @return Tempate as <code>InputStream</code>, or null if default getTemplate
+ * method should be used
*/
InputStream getTemplate(String viewName);
diff --git a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/ModifyableGuiBuilderConfiguration.java b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/ModifyableGuiBuilderConfiguration.java
index 9d6b10ef..9c4a4471 100644
--- a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/ModifyableGuiBuilderConfiguration.java
+++ b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/gui/ModifyableGuiBuilderConfiguration.java
@@ -26,24 +26,27 @@ public interface ModifyableGuiBuilderConfiguration {
/**
* Add a key/value pair into Velocity context.<br>
- * <b>IMPORTANT:</b> external HTML escapetion is required, because it is NOT done internally
+ * <b>IMPORTANT:</b> external HTML escapetion is required, because it is NOT
+ * done internally
*
- * @param group Group element of the key parameter, or null if root element should be set
- * @param key velocity context key, can be null in case of List based group element
+ * @param group Group element of the key parameter, or null if root element
+ * should be set
+ * @param key velocity context key, can be null in case of List based group
+ * element
* @param value of this key
*/
- void putCustomParameterWithOutEscaption(@Nullable GroupDefinition group, @Nullable String key,
- @Nonnull Object value);
+ void putCustomParameterWithOutEscaption(@Nullable GroupDefinition group, @Nullable String key, @Nonnull Object value);
/**
* Add a key/value pair into Velocity context.<br>
* All parameters get escaped internally
*
- * @param group Group element of the key parameter, or null if root element should be set
- * @param key velocity context key, can be null in case of List based group element
+ * @param group Group element of the key parameter, or null if root element
+ * should be set
+ * @param key velocity context key, can be null in case of List based group
+ * element
* @param value of this key
*/
- void putCustomParameter(@Nullable GroupDefinition group, @Nullable String key,
- @Nonnull String value);
+ void putCustomParameter(@Nullable GroupDefinition group, @Nullable String key, @Nonnull String value);
}