Skip to content

Commit

Permalink
Fixed Javadoc errors that stopped the building.
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelRoeder committed Dec 8, 2023
1 parent df9b160 commit 76aeabd
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 102 deletions.
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.10.1</version>
<version>3.6.3</version>
<configuration>
<show>private</show>
<nohelp>true</nohelp>
Expand Down
5 changes: 3 additions & 2 deletions src/main/java/org/hobbit/core/rabbit/GsonUtils.java
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,11 @@ public static <T> 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 <T> 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
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/hobbit/core/rabbit/QueueingConsumer.java
Original file line number Diff line number Diff line change
Expand Up @@ -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 &amp; Sourabh
*
*/
public class QueueingConsumer extends DefaultConsumer {
Expand Down
2 changes: 0 additions & 2 deletions src/main/java/org/hobbit/storage/queries/SparqlQueries.java
Original file line number Diff line number Diff line change
Expand Up @@ -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. <code>null</code> works
* like a wildcard.
Expand Down
54 changes: 6 additions & 48 deletions src/main/java/org/hobbit/utils/EnvVariables.java
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/
Expand Down Expand Up @@ -200,10 +198,6 @@ public static String getString(String name, Supplier<String> 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.
Expand All @@ -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
Expand Down Expand Up @@ -369,10 +359,6 @@ public static Model getModel(String name, Supplier<Model> 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.
Expand All @@ -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
Expand Down Expand Up @@ -538,10 +520,6 @@ public static int getInt(String name, Supplier<Integer> 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.
Expand All @@ -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
Expand Down Expand Up @@ -704,14 +678,10 @@ public static long getLong(String name, Supplier<Long> 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.
Expand All @@ -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
Expand Down Expand Up @@ -878,10 +844,6 @@ public static boolean getBoolean(String name, Supplier<Boolean> 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.
Expand All @@ -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
Expand Down
52 changes: 5 additions & 47 deletions src/main/java/org/hobbit/utils/config/HobbitConfiguration.java
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/
Expand Down Expand Up @@ -193,10 +191,6 @@ public String getString(String name, Supplier<String> 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.
Expand All @@ -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
Expand Down Expand Up @@ -362,10 +352,6 @@ public Model getModel(String name, Supplier<Model> 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.
Expand All @@ -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
Expand Down Expand Up @@ -531,10 +513,6 @@ public int getInt(String name, Supplier<Integer> 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.
Expand All @@ -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
Expand Down Expand Up @@ -701,10 +675,6 @@ public long getLong(String name, Supplier<Long> 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.
Expand All @@ -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
Expand Down Expand Up @@ -871,10 +837,6 @@ public boolean getBoolean(String name, Supplier<Boolean> 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.
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/org/hobbit/vocab/HobbitChallenges.java
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down

0 comments on commit 76aeabd

Please sign in to comment.