diff --git a/pom.xml b/pom.xml index 9b1c26f..43ab599 100644 --- a/pom.xml +++ b/pom.xml @@ -124,7 +124,7 @@ org.apache.maven.plugins maven-javadoc-plugin - 2.10.1 + 3.6.3 private true diff --git a/src/main/java/org/hobbit/core/rabbit/GsonUtils.java b/src/main/java/org/hobbit/core/rabbit/GsonUtils.java index 18c0f5c..df006cd 100644 --- a/src/main/java/org/hobbit/core/rabbit/GsonUtils.java +++ b/src/main/java/org/hobbit/core/rabbit/GsonUtils.java @@ -37,10 +37,11 @@ public static byte[] serializeObjectWithGson(Gson gson, T object) { /** * Deserialize a Java data object that was received as JSON with a command. * First, the given byte array will be transformed into a String using the - * {@link RabbitMQUtils} class, before it will be deserialized using the - * controller's {@link #gson} object. + * {@link RabbitMQUtils} class, before it will be deserialized using the given + * {@link Gson} object. * * @param The class that the data object should have. + * @param gson The Gson instance used to deserialize the JSON object. * @param data The byte array that has been received. * @param clazz The class that the data object should have. * @return The deserialized object or null if an error occurred diff --git a/src/main/java/org/hobbit/core/rabbit/QueueingConsumer.java b/src/main/java/org/hobbit/core/rabbit/QueueingConsumer.java index 853724a..46edf18 100644 --- a/src/main/java/org/hobbit/core/rabbit/QueueingConsumer.java +++ b/src/main/java/org/hobbit/core/rabbit/QueueingConsumer.java @@ -13,7 +13,7 @@ * with blocking semantics. The class provides a linked blocking queue * of {@link Delivery} class to fetch the next delivery message. * - * @author Altaf & Sourabh + * @author Altaf & Sourabh * */ public class QueueingConsumer extends DefaultConsumer { diff --git a/src/main/java/org/hobbit/storage/queries/SparqlQueries.java b/src/main/java/org/hobbit/storage/queries/SparqlQueries.java index c9cdcc8..faf39ad 100644 --- a/src/main/java/org/hobbit/storage/queries/SparqlQueries.java +++ b/src/main/java/org/hobbit/storage/queries/SparqlQueries.java @@ -107,8 +107,6 @@ private static final String loadQuery(String resourceName) { * Returns a SPARQL CONSTRUCT query for getting the analysis results of all * systems for a certain benchmark. * - * @param benchmarkUri - * URI of the benchmark * @param graphUri * URI of the graph the experiment is stored. null works * like a wildcard. diff --git a/src/main/java/org/hobbit/utils/EnvVariables.java b/src/main/java/org/hobbit/utils/EnvVariables.java index 822970d..1d3d01e 100644 --- a/src/main/java/org/hobbit/utils/EnvVariables.java +++ b/src/main/java/org/hobbit/utils/EnvVariables.java @@ -129,8 +129,6 @@ public static String getString(String name, String defaultValue) { * A factory method which can be used to generate a default value * which will be returned if the variable can not be found or if an * error occurs. - * @param logger - * the {@link Logger} which will be used to log errors if they occur. * @return the variable value or the default value if an error occurred and a * default value is available. */ @@ -200,10 +198,6 @@ public static String getString(String name, Supplier defaultValueFactory * * @param name * name of the environmental variable which should be accessed - * @param conversion - * the function which is used to convert the {@link String} of the - * variable value into the expected value type. It is assumed that - * this function will throw an exception if an error occurs. * @param defaultValue * the default value which will be returned if the variable can not * be found or if an error occurs. @@ -228,14 +222,10 @@ protected static String getStringValue(String name, String defaultValue, Logger /** * Internal method defining the conversion function before calling - * {@link #getVariableValue(String, Function, Object, Logger)}. + * {@link #getVariableValue(String, Function, Supplier, Logger, boolean)}. * * @param name * name of the environmental variable which should be accessed - * @param conversion - * the function which is used to convert the {@link String} of the - * variable value into the expected value type. It is assumed that - * this function will throw an exception if an error occurs. * @param defaultValueFactory * A factory method which can be used to generate a default value * which will be returned if the variable can not be found or if an @@ -369,10 +359,6 @@ public static Model getModel(String name, Supplier defaultValueFactory, L * * @param name * name of the environmental variable which should be accessed - * @param conversion - * the function which is used to convert the {@link String} of the - * variable value into the expected value type. It is assumed that - * this function will throw an exception if an error occurs. * @param defaultValue * the default value which will be returned if the variable can not * be found or if an error occurs. @@ -397,14 +383,10 @@ protected static Model getModelValue(String name, Model defaultValue, Logger log /** * Internal method defining the conversion function before calling - * {@link #getVariableValue(String, Function, Object, Logger)}. + * {@link #getVariableValue(String, Function, Supplier, Logger, boolean)}. * * @param name * name of the environmental variable which should be accessed - * @param conversion - * the function which is used to convert the {@link String} of the - * variable value into the expected value type. It is assumed that - * this function will throw an exception if an error occurs. * @param defaultValueFactory * A factory method which can be used to generate a default value * which will be returned if the variable can not be found or if an @@ -538,10 +520,6 @@ public static int getInt(String name, Supplier defaultValueFactory, Log * * @param name * name of the environmental variable which should be accessed - * @param conversion - * the function which is used to convert the {@link String} of the - * variable value into the expected value type. It is assumed that - * this function will throw an exception if an error occurs. * @param defaultValue * the default value which will be returned if the variable can not * be found or if an error occurs. @@ -567,14 +545,10 @@ protected static int getIntValue(String name, int defaultValue, Logger logger, b /** * Internal method defining the conversion function before calling - * {@link #getVariableValue(String, Function, Object, Logger)}. + * {@link #getVariableValue(String, Function, Supplier, Logger, boolean)}. * * @param name * name of the environmental variable which should be accessed - * @param conversion - * the function which is used to convert the {@link String} of the - * variable value into the expected value type. It is assumed that - * this function will throw an exception if an error occurs. * @param defaultValueFactory * A factory method which can be used to generate a default value * which will be returned if the variable can not be found or if an @@ -704,14 +678,10 @@ public static long getLong(String name, Supplier defaultValueFactory, Logg /** * Internal method defining the default value factory function before calling - * {@link #getLongValue(String, Supplier, Logger, boolean)}. + * {@link #getVariableValue(String, Function, Supplier, Logger, boolean)}. * * @param name * name of the environmental variable which should be accessed - * @param conversion - * the function which is used to convert the {@link String} of the - * variable value into the expected value type. It is assumed that - * this function will throw an exception if an error occurs. * @param defaultValue * the default value which will be returned if the variable can not * be found or if an error occurs. @@ -737,14 +707,10 @@ protected static long getLongValue(String name, long defaultValue, Logger logger /** * Internal method defining the conversion function before calling - * {@link #getVariableValue(String, Function, Object, Logger)}. + * {@link #getVariableValue(String, Function, Supplier, Logger, boolean)}. * * @param name * name of the environmental variable which should be accessed - * @param conversion - * the function which is used to convert the {@link String} of the - * variable value into the expected value type. It is assumed that - * this function will throw an exception if an error occurs. * @param defaultValueFactory * A factory method which can be used to generate a default value * which will be returned if the variable can not be found or if an @@ -878,10 +844,6 @@ public static boolean getBoolean(String name, Supplier defaultValueFact * * @param name * name of the environmental variable which should be accessed - * @param conversion - * the function which is used to convert the {@link String} of the - * variable value into the expected value type. It is assumed that - * this function will throw an exception if an error occurs. * @param defaultValue * the default value which will be returned if the variable can not * be found or if an error occurs. @@ -906,14 +868,10 @@ protected static boolean getBooleanValue(String name, boolean defaultValue, Logg /** * Internal method defining the conversion function before calling - * {@link #getVariableValue(String, Function, Object, Logger)}. + * {@link #getVariableValue(String, Function, Supplier, Logger, boolean)}. * * @param name * name of the environmental variable which should be accessed - * @param conversion - * the function which is used to convert the {@link String} of the - * variable value into the expected value type. It is assumed that - * this function will throw an exception if an error occurs. * @param defaultValueFactory * A factory method which can be used to generate a default value * which will be returned if the variable can not be found or if an diff --git a/src/main/java/org/hobbit/utils/config/HobbitConfiguration.java b/src/main/java/org/hobbit/utils/config/HobbitConfiguration.java index 2991182..ab3af48 100644 --- a/src/main/java/org/hobbit/utils/config/HobbitConfiguration.java +++ b/src/main/java/org/hobbit/utils/config/HobbitConfiguration.java @@ -122,8 +122,6 @@ public String getString(String name, String defaultValue) { * A factory method which can be used to generate a default value * which will be returned if the variable can not be found or if an * error occurs. - * @param logger - * the {@link Logger} which will be used to log errors if they occur. * @return the variable value or the default value if an error occurred and a * default value is available. */ @@ -193,10 +191,6 @@ public String getString(String name, Supplier defaultValueFactory, Logg * * @param name * name of the environmental variable which should be accessed - * @param conversion - * the function which is used to convert the {@link String} of the - * variable value into the expected value type. It is assumed that - * this function will throw an exception if an error occurs. * @param defaultValue * the default value which will be returned if the variable can not * be found or if an error occurs. @@ -221,14 +215,10 @@ protected String getStringValue(String name, String defaultValue, Logger logger /** * Internal method defining the conversion function before calling - * {@link #getVariableValue(String, Function, Object, Logger)}. + * {@link #getVariableValue(String, Function, Supplier, Logger, boolean)}. * * @param name * name of the environmental variable which should be accessed - * @param conversion - * the function which is used to convert the {@link String} of the - * variable value into the expected value type. It is assumed that - * this function will throw an exception if an error occurs. * @param defaultValueFactory * A factory method which can be used to generate a default value * which will be returned if the variable can not be found or if an @@ -362,10 +352,6 @@ public Model getModel(String name, Supplier defaultValueFactory, Logger * * @param name * name of the environmental variable which should be accessed - * @param conversion - * the function which is used to convert the {@link String} of the - * variable value into the expected value type. It is assumed that - * this function will throw an exception if an error occurs. * @param defaultValue * the default value which will be returned if the variable can not * be found or if an error occurs. @@ -390,14 +376,10 @@ protected Model getModelValue(String name, Model defaultValue, Logger logger, b /** * Internal method defining the conversion function before calling - * {@link #getVariableValue(String, Function, Object, Logger)}. + * {@link #getVariableValue(String, Function, Supplier, Logger, boolean)}. * * @param name * name of the environmental variable which should be accessed - * @param conversion - * the function which is used to convert the {@link String} of the - * variable value into the expected value type. It is assumed that - * this function will throw an exception if an error occurs. * @param defaultValueFactory * A factory method which can be used to generate a default value * which will be returned if the variable can not be found or if an @@ -531,10 +513,6 @@ public int getInt(String name, Supplier defaultValueFactory, Logger lo * * @param name * name of the environmental variable which should be accessed - * @param conversion - * the function which is used to convert the {@link String} of the - * variable value into the expected value type. It is assumed that - * this function will throw an exception if an error occurs. * @param defaultValue * the default value which will be returned if the variable can not * be found or if an error occurs. @@ -560,14 +538,10 @@ protected int getIntValue(String name, int defaultValue, Logger logger, boolean /** * Internal method defining the conversion function before calling - * {@link #getVariableValue(String, Function, Object, Logger)}. + * {@link #getVariableValue(String, Function, Supplier, Logger, boolean)}. * * @param name * name of the environmental variable which should be accessed - * @param conversion - * the function which is used to convert the {@link String} of the - * variable value into the expected value type. It is assumed that - * this function will throw an exception if an error occurs. * @param defaultValueFactory * A factory method which can be used to generate a default value * which will be returned if the variable can not be found or if an @@ -701,10 +675,6 @@ public long getLong(String name, Supplier defaultValueFactory, Logger log * * @param name * name of the environmental variable which should be accessed - * @param conversion - * the function which is used to convert the {@link String} of the - * variable value into the expected value type. It is assumed that - * this function will throw an exception if an error occurs. * @param defaultValue * the default value which will be returned if the variable can not * be found or if an error occurs. @@ -730,14 +700,10 @@ protected long getLongValue(String name, long defaultValue, Logger logger, bool /** * Internal method defining the conversion function before calling - * {@link #getVariableValue(String, Function, Object, Logger)}. + * {@link #getVariableValue(String, Function, Supplier, Logger, boolean)}. * * @param name * name of the environmental variable which should be accessed - * @param conversion - * the function which is used to convert the {@link String} of the - * variable value into the expected value type. It is assumed that - * this function will throw an exception if an error occurs. * @param defaultValueFactory * A factory method which can be used to generate a default value * which will be returned if the variable can not be found or if an @@ -871,10 +837,6 @@ public boolean getBoolean(String name, Supplier defaultValueFactory, L * * @param name * name of the environmental variable which should be accessed - * @param conversion - * the function which is used to convert the {@link String} of the - * variable value into the expected value type. It is assumed that - * this function will throw an exception if an error occurs. * @param defaultValue * the default value which will be returned if the variable can not * be found or if an error occurs. @@ -899,14 +861,10 @@ protected boolean getBooleanValue(String name, boolean defaultValue, Logger log /** * Internal method defining the conversion function before calling - * {@link #getVariableValue(String, Function, Object, Logger)}. + * {@link #getVariableValue(String, Function, Supplier, Logger, boolean)}. * * @param name * name of the environmental variable which should be accessed - * @param conversion - * the function which is used to convert the {@link String} of the - * variable value into the expected value type. It is assumed that - * this function will throw an exception if an error occurs. * @param defaultValueFactory * A factory method which can be used to generate a default value * which will be returned if the variable can not be found or if an diff --git a/src/main/java/org/hobbit/vocab/HobbitChallenges.java b/src/main/java/org/hobbit/vocab/HobbitChallenges.java index 7de3e64..7e93304 100644 --- a/src/main/java/org/hobbit/vocab/HobbitChallenges.java +++ b/src/main/java/org/hobbit/vocab/HobbitChallenges.java @@ -55,7 +55,7 @@ public static Resource getChallenge(String challengeId) { /** * returns the URI of a challenge resource given its ID * - * @param experimentId the challenge ID + * @param challengeId the challenge ID * @return the URI of challenge */ public static String getChallengeURI(String challengeId) {