diff --git a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/Action.java b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/Action.java index 9ff6b81694a..3ae02503d28 100644 --- a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/Action.java +++ b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/Action.java @@ -9,7 +9,6 @@ import java.util.Collections; import java.util.Map; -import java.util.Set; import org.eclipse.smarthome.automation.type.ActionType; import org.eclipse.smarthome.automation.type.Input; @@ -22,8 +21,7 @@ * Elements of this section are expected result of {@link Rule} execution. The * Action can have {@link Output} elements. These actions are used to process * input data as source data of other Actions. Building elements of actions ( {@link ConfigDescriptionParameter}s, - * {@link Input}s and {@link Output}s) are - * defined by {@link ActionType} + * {@link Input}s and {@link Output}s) are defined by {@link ActionType} * * @author Yordan Mihaylov - Initial Contribution * @author Ana Dimova - Initial Contribution @@ -51,10 +49,10 @@ public Action(String UID, String typeUID, Configuration configuration, Map getInputs() { return inputs != null ? inputs : Collections. emptyMap(); @@ -63,7 +61,7 @@ public Map getInputs() { /** * This method is used to connect {@link Input}s of the action to {@link Output}s of other {@link Module}s. * - * @param connections a {@link Set} of input {@link Input}s. + * @param inputs map that contains the inputs for this action. */ public void setInputs(Map inputs) { if (inputs != null) { diff --git a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/Condition.java b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/Condition.java index ffa8a129b19..df9a451b669 100644 --- a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/Condition.java +++ b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/Condition.java @@ -9,7 +9,6 @@ import java.util.Collections; import java.util.Map; -import java.util.Set; import org.eclipse.smarthome.automation.type.ConditionType; import org.eclipse.smarthome.automation.type.Input; @@ -47,11 +46,11 @@ public Condition(String id, String typeUID, Configuration configuration, Map getInputs() { return inputs != null ? inputs : Collections. emptyMap(); @@ -60,7 +59,7 @@ public Map getInputs() { /** * This method is used to connect {@link Input}s of the Condition to {@link Output}s of other {@link Module}s. * - * @param connections a {@link Set} of input {@link Input}s. + * @param inputs map that contains the inputs for this condition. */ public void setInputs(Map inputs) { if (inputs != null) { diff --git a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/Rule.java b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/Rule.java index f13c814043c..b99f34d87c6 100644 --- a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/Rule.java +++ b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/Rule.java @@ -136,10 +136,12 @@ public void setName(String ruleName) throws IllegalStateException { /** * Rules can have + *
    *
  • tags - non-hierarchical keywords or terms for describing them. This method is - * used for getting the tags assign to this Rule. The tags are used to filter the rules. + * used for getting the tags assign to this Rule. The tags are used to filter the rules.
  • + *
* - * @return a list of tags + * @return a {@link Set} of tags */ public Set getTags() { return tags = tags != null ? tags : Collections. emptySet(); @@ -147,13 +149,14 @@ public Set getTags() { /** * Rules can have + *
    *
  • tags - non-hierarchical keywords or terms for describing them. This method is * used for setting the tags to this rule. This property can be changed only when the Rule is not in active state. - * The tags are used to filter the rules. + * The tags are used to filter the rules.
  • + *
* * @param ruleTags list of tags assign to this Rule. - * @throws IllegalStateException IllegalStateException when the rule is in - * active state. + * @throws IllegalStateException when the rule is in active state. */ public void setTags(Set ruleTags) throws IllegalStateException { tags = ruleTags != null ? ruleTags : Collections. emptySet(); @@ -223,9 +226,8 @@ public void setConfiguration(Configuration ruleConfiguration) { } /** - * This method is used for getting the Set with {@link ConfigDescriptionParameter}s defining meta info for - * configuration - * properties of the Rule.
+ * This method is used for getting the {@link List} with {@link ConfigDescriptionParameter}s + * defining meta info for configuration properties of the Rule. * * @return a {@link Set} of {@link ConfigDescriptionParameter}s. */ @@ -310,7 +312,7 @@ private T getModule(String moduleUID, List modules) { } /** - * This method is used to return a group of module of this rule + * This method is used to return the module of this rule. * * @param moduleClazz optional parameter defining type looking modules. The * types are {@link Trigger}, {@link Condition} or {@link Action} diff --git a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/RuleRegistry.java b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/RuleRegistry.java index 6518c99c77b..a36c4b9c256 100644 --- a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/RuleRegistry.java +++ b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/RuleRegistry.java @@ -16,10 +16,10 @@ * The {@link RuleRegistry} provides basic functionality for managing {@link Rule}s. * It can be used to *
    - *
  • Add Rules with the {@link #add(Rule)} method.
  • + *
  • Add Rules with the {@link Registry#add(Object)} method.
  • *
  • Get the existing rules with the {@link #getByTag(String)}, {@link #getByTags(String[])} methods.
  • - *
  • Update the existing rules with the {@link #update(Rule)} method.
  • - *
  • Remove Rules with the {@link #remove(String)} method.
  • + *
  • Update the existing rules with the {@link Registry#update(Object)} method.
  • + *
  • Remove Rules with the {@link Registry#remove(Object)} method.
  • *
  • Manage the state (enabled or disabled) of the Rules: *
      *
    • A newly added Rule is always enabled.
    • @@ -107,23 +107,23 @@ public interface RuleRegistry extends Registry { public Boolean isEnabled(String ruleUID); /** - * The method "runNow(ruleUID)" skips triggers&conditions and directly executes the actions of the rule. + * The method "runNow(ruleUID)" skips the triggers and the conditions and directly executes the actions of the rule. * This should always be possible unless an action has a mandatory input that is linked to a trigger. * In that case the action is skipped and the RuleEngine continues execution of rest actions. * - * @param ruleUID id of rule whose actions have to be executed. + * @param ruleUID id of rule whose actions have to be executed * */ public void runNow(String ruleUID); - + /** - * Same as {@link RuleRegistry#runNow(String)} with additional option to enable/disable evaluation of - * conditions defined in the target rule. The context can be set here, too but also might be null. - * - * @param ruleUID - * @param considerConditions - * @param context - */ - public void runNow(String ruleUID, boolean considerConditions, Map context); + * Same as {@link RuleRegistry#runNow(String)} with additional option to enable/disable evaluation of + * conditions defined in the target rule. The context can be set here, too but also might be null. + * + * @param ruleUID id of rule whose actions have to be executed + * @param considerConditions if true the conditions will be checked + * @param context the context that is passed to the conditions and the actions + */ + public void runNow(String ruleUID, boolean considerConditions, Map context); } diff --git a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/events/AbstractRuleRegistryEvent.java b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/events/AbstractRuleRegistryEvent.java index 1382efca21c..ed9a6b5c25f 100644 --- a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/events/AbstractRuleRegistryEvent.java +++ b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/events/AbstractRuleRegistryEvent.java @@ -24,10 +24,10 @@ public abstract class AbstractRuleRegistryEvent extends AbstractEvent { /** * Must be called in subclass constructor to create a new rule registry event. * - * @param topic - * @param payload - * @param source - * @param ruleDTO + * @param topic the topic of the event + * @param payload the payload of the event + * @param source the source of the event + * @param ruleDTO the ruleDTO for which this event is created */ public AbstractRuleRegistryEvent(String topic, String payload, String source, RuleDTO rule) { super(topic, payload, source); @@ -35,9 +35,7 @@ public AbstractRuleRegistryEvent(String topic, String payload, String source, Ru } /** - * returns the RuleDTO which caused the Event - * - * @return + * @return the RuleDTO which caused the Event */ public RuleDTO getRule() { return this.rule; diff --git a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/events/RuleAddedEvent.java b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/events/RuleAddedEvent.java index 839fe9624eb..6c868b79ca4 100644 --- a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/events/RuleAddedEvent.java +++ b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/events/RuleAddedEvent.java @@ -23,10 +23,10 @@ public class RuleAddedEvent extends AbstractRuleRegistryEvent { /** * constructs a new rule added event * - * @param topic - * @param payload - * @param source - * @param ruleDTO + * @param topic the topic of the event + * @param payload the payload of the event + * @param source the source of the event + * @param ruleDTO the rule for which this event is created */ public RuleAddedEvent(String topic, String payload, String source, RuleDTO rule) { super(topic, payload, source, rule); diff --git a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/events/RuleEventFactory.java b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/events/RuleEventFactory.java index 5f4fb325281..00a6ed137d7 100644 --- a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/events/RuleEventFactory.java +++ b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/events/RuleEventFactory.java @@ -102,12 +102,12 @@ private String getRuleId(String topic) { } /** - * creates a rule updated event + * Creates a rule updated event * - * @param rule the updated rule - * @param oldRule the old rule - * @param source - * @return + * @param rule the new rule + * @param oldRule the rule that has been updated + * @param source the source of the event + * @return {@link RuleUpdatedEvent} instance */ public static RuleUpdatedEvent createRuleUpdatedEvent(Rule rule, Rule oldRule, String source) { String topic = buildTopic(RULE_UPDATED_EVENT_TOPIC, rule); @@ -121,12 +121,12 @@ public static RuleUpdatedEvent createRuleUpdatedEvent(Rule rule, Rule oldRule, S } /** - * creates a rule status info event + * Creates a rule status info event * - * @param statusInfo - * @param rule - * @param source - * @return + * @param statusInfo the status info of the event + * @param ruleUID the UID of the rule for which the event is created + * @param source the source of the event + * @return {@link RuleStatusInfoEvent} instance */ public static RuleStatusInfoEvent createRuleStatusInfoEvent(RuleStatusInfo statusInfo, String ruleUID, String source) { @@ -136,11 +136,11 @@ public static RuleStatusInfoEvent createRuleStatusInfoEvent(RuleStatusInfo statu } /** - * creates a rule removed event + * Creates a rule removed event * - * @param rule - * @param source - * @return + * @param rule the rule for which this event is created + * @param source the source of the event + * @return {@link RuleRemovedEvent} instance */ public static RuleRemovedEvent createRuleRemovedEvent(Rule rule, String source) { String topic = buildTopic(RULE_REMOVED_EVENT_TOPIC, rule); @@ -150,11 +150,11 @@ public static RuleRemovedEvent createRuleRemovedEvent(Rule rule, String source) } /** - * creates a rule added event + * Creates a rule added event * - * @param rule - * @param source - * @return + * @param rule the rule for which this event is created + * @param source the source of the event + * @return {@link RuleAddedEvent} instance */ public static RuleAddedEvent createRuleAddedEvent(Rule rule, String source) { String topic = buildTopic(RULE_ADDED_EVENT_TOPIC, rule); diff --git a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/events/RuleRemovedEvent.java b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/events/RuleRemovedEvent.java index ac1bf1ec783..0d1000bbae2 100644 --- a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/events/RuleRemovedEvent.java +++ b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/events/RuleRemovedEvent.java @@ -21,12 +21,12 @@ public class RuleRemovedEvent extends AbstractRuleRegistryEvent { public static final String TYPE = RuleRemovedEvent.class.getSimpleName(); /** - * constructs a new rule removed event + * Constructs a new rule removed event * - * @param topic - * @param payload - * @param source - * @param ruleDTO + * @param topic the topic of the event + * @param payload the payload of the event + * @param source the source of the event + * @param rule the rule for which this event is */ public RuleRemovedEvent(String topic, String payload, String source, RuleDTO rule) { super(topic, payload, source, rule); diff --git a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/events/RuleStatusInfoEvent.java b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/events/RuleStatusInfoEvent.java index 17ffe41cdd7..12eac28f747 100644 --- a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/events/RuleStatusInfoEvent.java +++ b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/events/RuleStatusInfoEvent.java @@ -28,10 +28,11 @@ public class RuleStatusInfoEvent extends AbstractEvent { /** * constructs a new rule status event * - * @param topic - * @param payload - * @param source - * @param ruleDTO + * @param topic the topic of the event + * @param payload the payload of the event + * @param source the source of the event + * @param statusInfo the status info for this event + * @param ruleId the rule for which this event is */ public RuleStatusInfoEvent(String topic, String payload, String source, RuleStatusInfo statusInfo, String ruleId) { super(topic, payload, source); diff --git a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/events/RuleUpdatedEvent.java b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/events/RuleUpdatedEvent.java index 0ae6b1f8269..9c01e9baa8e 100644 --- a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/events/RuleUpdatedEvent.java +++ b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/events/RuleUpdatedEvent.java @@ -25,10 +25,11 @@ public class RuleUpdatedEvent extends AbstractRuleRegistryEvent { /** * constructs a new rule updated event * - * @param topic - * @param payload - * @param source - * @param ruleDTO + * @param topic the topic of the event + * @param payload the payload of the event + * @param source the source of the event + * @param rule the rule for which is this event + * @param oldRule the rule that has been updated */ public RuleUpdatedEvent(String topic, String payload, String source, RuleDTO rule, RuleDTO oldRule) { super(topic, payload, source, rule); diff --git a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/handler/ModuleHandlerFactory.java b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/handler/ModuleHandlerFactory.java index 7272f6cc2a4..934f0dc87e0 100644 --- a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/handler/ModuleHandlerFactory.java +++ b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/handler/ModuleHandlerFactory.java @@ -27,7 +27,7 @@ public interface ModuleHandlerFactory { /** * This method is used to return UIDs of module types supported by this {@link ModuleHandlerFactory} * - * @return collection of module type unequal ids supported by this factory. + * @return collection of module type unequal UID supported by this factory. */ public Collection getTypes(); @@ -35,17 +35,16 @@ public interface ModuleHandlerFactory { * This method is used to get a ModuleHandler instance for the passed module * instance * - * @param module module instance for which the {@link ModuleHandler} instance is - * created for. - * - * @return ModuleHandler instance. + * @param module module instance for which the {@link ModuleHandler} instance is created. + * @param ruleUID the UID of the rule for which the handler instance is created. + * @return {@link ModuleHandler} instance. */ public ModuleHandler getHandler(Module module, String ruleUID); /** - * This method signalizes the Factory that a ModuleHandler for the passed module is not needed anymore. Implementors + * This method signalises the Factory that a ModuleHandler for the passed module is not needed anymore. Implementors * must take care of invalidating caches and disposing the Handlers. - * + * * @param module */ public void ungetHandler(Module module, String ruleUID, ModuleHandler handler); diff --git a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/template/RuleTemplate.java b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/template/RuleTemplate.java index 81b6a970925..c80034fe847 100644 --- a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/template/RuleTemplate.java +++ b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/template/RuleTemplate.java @@ -96,12 +96,15 @@ protected RuleTemplate() { /** * This constructor creates a {@link RuleTemplate} instance. * - * @param UID is an unique identifier of the {@link RuleTemplate} instance. - * @param triggers - list of unique {@link Trigger}s participating in the {@link Rule} - * @param conditions - list of unique {@link Condition}s participating in the {@link Rule} - * @param actions - list of unique {@link Action}s participating in the {@link Rule} - * @param configDescriptions - set of configuration properties of the {@link Rule} - * @param visibility defines if the template can be public or private. + * @param UID is an unique identifier of the {@link RuleTemplate} instance + * @param label short human readable description + * @param description a detailed human readable description + * @param tags a set of tags + * @param triggers list of unique {@link Trigger}s participating in the {@link Rule} + * @param conditions list of unique {@link Condition}s participating in the {@link Rule} + * @param actions list of unique {@link Action}s participating in the {@link Rule} + * @param configDescriptions set of configuration properties of the {@link Rule} + * @param visibility defines if the template can be public or private */ public RuleTemplate(String UID, String label, String description, Set tags, List triggers, List conditions, List actions, List configDescriptions, @@ -191,6 +194,7 @@ public List getConfigurationDescriptions() { * This method is used to get a {@link Module} participating in Rule * * @param id unique id of the module in this rule. + * @param the type of the module * @return module with specified id or null when it does not exist. */ public T getModule(String id) { @@ -200,8 +204,9 @@ public T getModule(String id) { /** * This method is used to return a group of {@link Module}s of this rule * - * @param clazz optional parameter defining type looking modules. The types + * @param moduleClazz optional parameter defining type looking modules. The types * are {@link Trigger}, {@link Condition} or {@link Action} + * @param the type of the module that is required * @return list of modules of defined type or all modules when the type is not * specified. */ diff --git a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/template/RuleTemplateProvider.java b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/template/RuleTemplateProvider.java index adc586e8e70..c1078193b63 100644 --- a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/template/RuleTemplateProvider.java +++ b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/template/RuleTemplateProvider.java @@ -13,9 +13,23 @@ *******************************************************************************/ package org.eclipse.smarthome.automation.template; +import java.util.Locale; + +import org.eclipse.smarthome.core.common.registry.Provider; +import org.eclipse.smarthome.core.common.registry.ProviderChangeListener; + /** - * @author Ana Dimova + * The {@link RuleTemplateProvider} provides basic functionality for managing {@link RuleTemplate}s. + * It can be used for + *
        + *
      • Get the existing {@link RuleTemplate}s with the {@link Provider#getAll()}, + * {@link TemplateProvider#getTemplates(Locale)} and {@link #getTemplate(String, Locale)} methods.
      • + *
      + * Listers that are listening for adding removing or updating can be added with the + * {@link #addProviderChangeListener(ProviderChangeListener)} + * and removed with the {@link #removeProviderChangeListener(ProviderChangeListener)} methods. * + * @author Ana Dimova */ public interface RuleTemplateProvider extends TemplateProvider { diff --git a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/template/Template.java b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/template/Template.java index 11aaa027f3e..8a97324c0ca 100644 --- a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/template/Template.java +++ b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/template/Template.java @@ -38,8 +38,10 @@ public interface Template { /** * Templates can have + *
        *
      • tags - non-hierarchical keywords or terms for describing them. The tags are - * used to filter the templates. This method is used for getting the assign tags to this Template. + * used to filter the templates. This method is used for getting the assign tags to this Template.
      • + *
      * * @return tags of the template */ diff --git a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/template/TemplateRegistry.java b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/template/TemplateRegistry.java index 27de9ddd788..f8423a2c1f2 100644 --- a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/template/TemplateRegistry.java +++ b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/template/TemplateRegistry.java @@ -37,7 +37,9 @@ public interface TemplateRegistry extends Registrynull then returns all templates. + * * @param tag specifies the filter for getting the templates, if it is null then returns all + * templates. + * * @return the templates, which correspond to the specified filter. */ public Collection getByTag(String tag); @@ -71,7 +73,9 @@ public interface TemplateRegistry extends Registry getAll(Locale locale); diff --git a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/ActionType.java b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/ActionType.java index 55cae29595d..87f39b436c1 100644 --- a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/ActionType.java +++ b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/ActionType.java @@ -102,7 +102,7 @@ public ActionType(String UID, List configDescription } /** - * This method is used for getting the meta-information descriptions of {@link Input}s defined by this type.
      + * This method is used for getting the meta-information descriptions of {@link Input}s defined by this type. * * @return a {@link List} of {@link Input} definitions. */ @@ -111,7 +111,7 @@ public List getInputs() { } /** - * This method is used for getting the meta-information descriptions of {@link Output}s defined by this type.
      + * This method is used for getting the meta-information descriptions of {@link Output}s defined by this type. * * @return a {@link List} of {@link Output} definitions. */ diff --git a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/Input.java b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/Input.java index 43dd3b20824..9604bfabfb4 100644 --- a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/Input.java +++ b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/Input.java @@ -95,7 +95,7 @@ public Input(String name, String type) { * @param description user friendly description of the {@code Input}. * @param tags are associated with the {@code Input}. The tags adds additional restrictions to connections between * {@code Input}s and {@link Output}s. The input tags must be subset of the output tags to succeed the - * connection.
      + * connection. * For example: When we want to connect input to output and both have same * java.lang.double data type. The the output has assign "temperature" and "celsius" tags then the input * must have at least one of these output's tags (i.e. "temperature") to connect this {@code Input} to @@ -176,7 +176,7 @@ public String getType() { /** * This method is used for getting the tags of the Input. The tags add additional restrictions to connections * between {@link Input}s and {@link Output}s. The input tags must be subset of the output tags to succeed the - * connection.
      + * connection. * For example: When we want to connect input to output and they both have same java.lang.double * data type, and the output has assign "temperature" and "celsius" tags then the input must have at least one of * these output's tags (i.e. "temperature") to connect this input to the selected output. diff --git a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/ModuleType.java b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/ModuleType.java index 7f2481b4637..f972c562224 100644 --- a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/ModuleType.java +++ b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/ModuleType.java @@ -114,8 +114,8 @@ public String getUID() { } /** - * This method is used for getting the Set of {@link ConfigDescriptionParameter}s defined by this {@link ModuleType} - * .
      + * This method is used for getting the Set of {@link ConfigDescriptionParameter}s defined by this + * {@link ModuleType}. * * @return a {@link Set} of meta-information configuration descriptions. */ @@ -125,9 +125,11 @@ public List getConfigurationDescriptions() { /** * {@link ModuleType}s can have + *
        *
      • tags which are non-hierarchical keywords or terms for describing * them. The tags are used to filter the ModuleTypes. This method is used for getting the tags assign to this - * {@link ModuleType}. + * {@link ModuleType}.
      • + *
      * * @return {@link #tags} assign to this {@link ModuleType} */ diff --git a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/ModuleTypeProvider.java b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/ModuleTypeProvider.java index 237004d98d4..e14f75e5011 100644 --- a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/ModuleTypeProvider.java +++ b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/ModuleTypeProvider.java @@ -29,6 +29,7 @@ public interface ModuleTypeProvider extends Provider { * * @param UID unique id of module type. * @param locale defines localization of label and description of the {@link ModuleType} or null. + * @param the type of the required object. * @return localized module type. */ T getModuleType(String UID, Locale locale); @@ -39,6 +40,7 @@ public interface ModuleTypeProvider extends Provider { * with default localization is returned. * * @param locale defines localization of label and description of the {@link ModuleType}s or null. + * @param the type of the required object. * @return collection of localized {@link ModuleType} provided by this * provider */ diff --git a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/ModuleTypeRegistry.java b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/ModuleTypeRegistry.java index 8d56e669ae9..53b4c04268e 100644 --- a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/ModuleTypeRegistry.java +++ b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/ModuleTypeRegistry.java @@ -29,6 +29,7 @@ public interface ModuleTypeRegistry extends Registry { * * @param moduleTypeUID the an unique id in scope of registered ModuleTypes * @param locale used for localization of the ModuleType + * @param the type of the required object * @return ModuleType instance or null. */ public T get(String moduleTypeUID, Locale locale); @@ -38,6 +39,7 @@ public interface ModuleTypeRegistry extends Registry { * * @param moduleTypeTag specifies the filter for getting the ModuleTypes, if * it is null then returns all ModuleTypes. + * @param the type of the required object * @return the ModuleTypes, which correspond to the specified filter. */ public Collection getByTag(String moduleTypeTag); @@ -48,6 +50,7 @@ public interface ModuleTypeRegistry extends Registry { * @param moduleTypeTag specifies the filter for getting the ModuleTypes, if * it is null then returns all ModuleTypes. * @param locale used for localization of the ModuleType + * @param the type of the required object * @return the ModuleTypes, which correspond to the specified filter. */ public Collection getByTag(String moduleTypeTag, Locale locale); @@ -57,6 +60,7 @@ public interface ModuleTypeRegistry extends Registry { * * @param tags specifies the filter for getting the ModuleTypes, if * it is null then returns all ModuleTypes. + * @param the type of the required object * @return the ModuleTypes, which correspond to the filter. */ public Collection getByTags(String... tags); @@ -67,6 +71,7 @@ public interface ModuleTypeRegistry extends Registry { * @param locale used for localization of the ModuleType * @param moduleTypeTag specifies the filter for getting the ModuleTypes, if * it is null then returns all ModuleTypes. + * @param the type of the required object * @return the ModuleTypes, which correspond to the filter. */ public Collection getByTags(Locale locale, String... tags); diff --git a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/Output.java b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/Output.java index 618a29136df..552df29594f 100644 --- a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/Output.java +++ b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/Output.java @@ -110,7 +110,7 @@ public Output(String name, String type) { * @param description is an user friendly description of the {@code Output}. * @param tags are associated with the {@code Output}. The tags add additional restrictions to connections between * {@link Input}s and {@link Output}s. The {@link Input}'s tags must be subset of the {@code Output}'s - * tags to succeed the connection.
      + * tags to succeed the connection.
      * For example: When we want to connect {@link Input} to * {@code Output} and both have same java.lang.double data type. The the output has assign "temperature" * and "celsius" tags then the input must have at least one of these output's tags (i.e. "temperature") @@ -191,7 +191,7 @@ public String getReference() { /** * This method is used for getting the tags of the {@code Output}. The tags add additional restrictions to * connections between {@link Input}s and {@code Output}s. The input tags must be subset of the output tags to - * succeed the connection.
      + * succeed the connection.
      * For example: When we want to connect {@link Input} to {@code Output} and they both * have same data type - java.lang.double and the {@link Output} has assign "temperature" and "celsius" tags, then * the {@link Input} must have at least one of these {@code Output}'s tags (i.e. "temperature") to connect this diff --git a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/TriggerType.java b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/TriggerType.java index 57a2db0f106..63c4d104ee5 100644 --- a/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/TriggerType.java +++ b/bundles/automation/org.eclipse.smarthome.automation.api/src/main/java/org/eclipse/smarthome/automation/type/TriggerType.java @@ -76,7 +76,7 @@ public TriggerType(String UID, List configDescriptio } /** - * This method is used for getting the meta-information descriptions of {@link Output}s defined by this type.
      + * This method is used for getting the meta-information descriptions of {@link Output}s defined by this type.
      * * @return a {@link List} of {@link Output} definitions. */ diff --git a/bundles/config/org.eclipse.smarthome.config.core/src/main/java/org/eclipse/smarthome/config/core/ConfigDescriptionParameterBuilder.java b/bundles/config/org.eclipse.smarthome.config.core/src/main/java/org/eclipse/smarthome/config/core/ConfigDescriptionParameterBuilder.java index a0ca13900e1..fe72716d89d 100644 --- a/bundles/config/org.eclipse.smarthome.config.core/src/main/java/org/eclipse/smarthome/config/core/ConfigDescriptionParameterBuilder.java +++ b/bundles/config/org.eclipse.smarthome.config.core/src/main/java/org/eclipse/smarthome/config/core/ConfigDescriptionParameterBuilder.java @@ -68,7 +68,8 @@ public static ConfigDescriptionParameterBuilder create(String name, Type type) { /** * Set the minimum value of the configuration parameter * - * @param min + * @param min the min value of the {@link ConfigDescriptionParameter} + * @return the updated builder instance */ public ConfigDescriptionParameterBuilder withMinimum(BigDecimal min) { this.min = min; @@ -78,7 +79,8 @@ public ConfigDescriptionParameterBuilder withMinimum(BigDecimal min) { /** * Set the maximum value of the configuration parameter * - * @param max + * @param max the max value of the {@link ConfigDescriptionParameter} + * @return the updated builder instance */ public ConfigDescriptionParameterBuilder withMaximum(BigDecimal max) { this.max = max; @@ -88,7 +90,8 @@ public ConfigDescriptionParameterBuilder withMaximum(BigDecimal max) { /** * Set the step size of the configuration parameter * - * @param step + * @param step the step of the {@link ConfigDescriptionParameter} + * @return the updated builder instance */ public ConfigDescriptionParameterBuilder withStepSize(BigDecimal step) { this.step = step; @@ -98,7 +101,8 @@ public ConfigDescriptionParameterBuilder withStepSize(BigDecimal step) { /** * Set the pattern of the configuration parameter * - * @param pattern + * @param pattern the pattern for the {@link ConfigDescriptionParameter} + * @return the updated builder instance */ public ConfigDescriptionParameterBuilder withPattern(String pattern) { this.pattern = pattern; @@ -108,7 +112,8 @@ public ConfigDescriptionParameterBuilder withPattern(String pattern) { /** * Set the configuration parameter as read only * - * @param readOnly + * @param readOnly true to make the parameter read only + * @return the updated builder instance */ public ConfigDescriptionParameterBuilder withReadOnly(Boolean readOnly) { this.readOnly = readOnly; @@ -118,7 +123,8 @@ public ConfigDescriptionParameterBuilder withReadOnly(Boolean readOnly) { /** * Set the configuration parameter to allow multiple selection * - * @param multiple + * @param multiple true for multiple selection + * @return the updated builder instance */ public ConfigDescriptionParameterBuilder withMultiple(Boolean multiple) { this.multiple = multiple; @@ -128,7 +134,8 @@ public ConfigDescriptionParameterBuilder withMultiple(Boolean multiple) { /** * Set the configuration parameter to allow multiple selection * - * @param multiple + * @param multipleLimit the parameters limit + * @return the updated builder instance */ public ConfigDescriptionParameterBuilder withMultipleLimit(Integer multipleLimit) { this.multipleLimit = multipleLimit; @@ -138,7 +145,8 @@ public ConfigDescriptionParameterBuilder withMultipleLimit(Integer multipleLimit /** * Set the context of the configuration parameter * - * @param context + * @param context the context for this parameter + * @return the updated builder instance */ public ConfigDescriptionParameterBuilder withContext(String context) { this.context = context; @@ -148,7 +156,8 @@ public ConfigDescriptionParameterBuilder withContext(String context) { /** * Set the configuration parameter to be required * - * @param required + * @param required true if the parameter is required + * @return the updated builder instance */ public ConfigDescriptionParameterBuilder withRequired(Boolean required) { this.required = required; @@ -158,7 +167,8 @@ public ConfigDescriptionParameterBuilder withRequired(Boolean required) { /** * Set the default value of the configuration parameter * - * @param defaultValue + * @param defaultValue the default value of the configuration parameter + * @return the updated builder instance */ public ConfigDescriptionParameterBuilder withDefault(String defaultValue) { this.defaultValue = defaultValue; @@ -168,7 +178,8 @@ public ConfigDescriptionParameterBuilder withDefault(String defaultValue) { /** * Set the label of the configuration parameter * - * @param label + * @param label a short user friendly description + * @return the updated builder instance */ public ConfigDescriptionParameterBuilder withLabel(String label) { this.label = label; @@ -178,7 +189,8 @@ public ConfigDescriptionParameterBuilder withLabel(String label) { /** * Set the description of the configuration parameter * - * @param description + * @param description a detailed user friendly description + * @return the updated builder instance */ public ConfigDescriptionParameterBuilder withDescription(String description) { this.description = description; @@ -188,7 +200,8 @@ public ConfigDescriptionParameterBuilder withDescription(String description) { /** * Set the options of the configuration parameter * - * @param options + * @param options the options for this parameter + * @return the updated builder instance */ public ConfigDescriptionParameterBuilder withOptions(List options) { this.options = options; @@ -198,7 +211,8 @@ public ConfigDescriptionParameterBuilder withOptions(List optio /** * Set the configuration parameter as an advanced parameter * - * @param options + * @param advanced true to make the parameter advanced + * @return the updated builder instance */ public ConfigDescriptionParameterBuilder withAdvanced(Boolean advanced) { this.advanced = advanced; @@ -208,7 +222,8 @@ public ConfigDescriptionParameterBuilder withAdvanced(Boolean advanced) { /** * Set the configuration parameter to be limited to the values in the options list * - * @param options + * @param limitToOptions true if only the declared options are acceptable + * @return the updated builder instance */ public ConfigDescriptionParameterBuilder withLimitToOptions(Boolean limitToOptions) { this.limitToOptions = limitToOptions; @@ -218,7 +233,8 @@ public ConfigDescriptionParameterBuilder withLimitToOptions(Boolean limitToOptio /** * Set the configuration parameter to be limited to the values in the options list * - * @param options + * @param groupName the group name of this config description parameter + * @return the updated builder instance */ public ConfigDescriptionParameterBuilder withGroupName(String groupName) { this.groupName = groupName; @@ -228,7 +244,8 @@ public ConfigDescriptionParameterBuilder withGroupName(String groupName) { /** * Set the filter criteria of the configuration parameter * - * @param filterCriteria + * @param filterCriteria the filter criteria + * @return the updated builder instance */ public ConfigDescriptionParameterBuilder withFilterCriteria(List filterCriteria) { this.filterCriteria = filterCriteria; diff --git a/bundles/config/org.eclipse.smarthome.config.core/src/main/java/org/eclipse/smarthome/config/core/ConfigUtil.java b/bundles/config/org.eclipse.smarthome.config.core/src/main/java/org/eclipse/smarthome/config/core/ConfigUtil.java index 81670e0d91b..78be8d1ae82 100644 --- a/bundles/config/org.eclipse.smarthome.config.core/src/main/java/org/eclipse/smarthome/config/core/ConfigUtil.java +++ b/bundles/config/org.eclipse.smarthome.config.core/src/main/java/org/eclipse/smarthome/config/core/ConfigUtil.java @@ -31,7 +31,7 @@ public class ConfigUtil { /** * Normalizes the types to the ones allowed for configurations. * - * @param configuration + * @param configuration the configuration that needs to be normalzed * @return normalized configuration */ public static Map normalizeTypes(Map configuration) { @@ -58,6 +58,7 @@ public static Object normalizeType(Object value) { * Normalizes the type of the parameter to the one allowed for configurations. * * @param value the value to return as normalized type + * @param configDescriptionParameter the parameter that needs to be normalized * @return corresponding value as a valid type * @throws IllegalArgumentException if a invalid type has been given */ diff --git a/bundles/core/org.eclipse.smarthome.core/src/main/java/org/eclipse/smarthome/core/common/registry/ProviderChangeListener.java b/bundles/core/org.eclipse.smarthome.core/src/main/java/org/eclipse/smarthome/core/common/registry/ProviderChangeListener.java index cbeed5a0a05..709632e99b4 100644 --- a/bundles/core/org.eclipse.smarthome.core/src/main/java/org/eclipse/smarthome/core/common/registry/ProviderChangeListener.java +++ b/bundles/core/org.eclipse.smarthome.core/src/main/java/org/eclipse/smarthome/core/common/registry/ProviderChangeListener.java @@ -22,30 +22,24 @@ public interface ProviderChangeListener { /** * Notifies the listener that a single element has been added. * - * @param provider - * element provider - * @param element - * the element that has been added + * @param provider the provider that provides the element + * @param element the element that has been added */ void added(Provider provider, E element); /** * Notifies the listener that a single element has been removed. * - * @param provider - * element provider - * @param element - * the element that has been removed + * @param provider the provider that provides the element + * @param element the element that has been removed */ void removed(Provider provider, E element); /** * Notifies the listener that a single element has been updated. * - * @param provider - * element provider - * @param element - * the element that has been update + * @param provider the provider that provides the element + * @param element the element that has been updated */ void updated(Provider provider, E oldelement, E element); diff --git a/bundles/core/org.eclipse.smarthome.core/src/main/java/org/eclipse/smarthome/core/common/registry/Registry.java b/bundles/core/org.eclipse.smarthome.core/src/main/java/org/eclipse/smarthome/core/common/registry/Registry.java index 724c9e02f63..2c174cc9d65 100644 --- a/bundles/core/org.eclipse.smarthome.core/src/main/java/org/eclipse/smarthome/core/common/registry/Registry.java +++ b/bundles/core/org.eclipse.smarthome.core/src/main/java/org/eclipse/smarthome/core/common/registry/Registry.java @@ -11,20 +11,18 @@ /** * The {@link Registry} interface represents a registry for elements of the type - * E. The concrete subinterfaces are registered as OSGi services. + * E. The concrete sub interfaces are registered as OSGi services. * * @author Dennis Nobel - Initial contribution * - * @param - * type of the elements in the registry + * @param type of the elements in the registry */ public interface Registry { /** * Adds a {@link RegistryChangeListener} to the registry. * - * @param listener - * registry change listener + * @param listener registry change listener */ void addRegistryChangeListener(RegistryChangeListener listener); diff --git a/bundles/core/org.eclipse.smarthome.core/src/main/java/org/eclipse/smarthome/core/common/registry/RegistryChangeListener.java b/bundles/core/org.eclipse.smarthome.core/src/main/java/org/eclipse/smarthome/core/common/registry/RegistryChangeListener.java index 64da4959ce3..4f7d1617639 100644 --- a/bundles/core/org.eclipse.smarthome.core/src/main/java/org/eclipse/smarthome/core/common/registry/RegistryChangeListener.java +++ b/bundles/core/org.eclipse.smarthome.core/src/main/java/org/eclipse/smarthome/core/common/registry/RegistryChangeListener.java @@ -13,32 +13,29 @@ * * @author Dennis Nobel - Initial contribution * - * @param - * type of the element in the registry + * @param type of the element in the registry */ public interface RegistryChangeListener { /** * Notifies the listener that a single element has been added. * - * @param element - * the element that has been added + * @param element the element that has been added */ void added(E element); /** * Notifies the listener that a single element has been removed. * - * @param element - * the element that has been removed + * @param element the element that has been removed */ void removed(E element); /** * Notifies the listener that a single element has been updated. * - * @param element - * the element that has been update + * @param element the new element + * @param oldElement the element that has been updated */ void updated(E oldElement, E element); diff --git a/bundles/core/org.eclipse.smarthome.core/src/main/java/org/eclipse/smarthome/core/events/AbstractEventFactory.java b/bundles/core/org.eclipse.smarthome.core/src/main/java/org/eclipse/smarthome/core/events/AbstractEventFactory.java index 047407bb06b..1de8ee8faab 100644 --- a/bundles/core/org.eclipse.smarthome.core/src/main/java/org/eclipse/smarthome/core/events/AbstractEventFactory.java +++ b/bundles/core/org.eclipse.smarthome.core/src/main/java/org/eclipse/smarthome/core/events/AbstractEventFactory.java @@ -18,7 +18,7 @@ * must implement the abstract method {@link #createEventByType(String, String, String, String)} in order to create * event * instances based on the event type. - * + * * @author Stefan Bußweiler - Initial contribution */ public abstract class AbstractEventFactory implements EventFactory { @@ -29,7 +29,7 @@ public abstract class AbstractEventFactory implements EventFactory { /** * Must be called in subclass constructor to define the supported event types. - * + * * @param supportedEventTypes the supported event types */ public AbstractEventFactory(Set supportedEventTypes) { @@ -63,14 +63,14 @@ private void assertValidArguments(String eventType, String topic, String payload /** * Create a new event instance based on the event type. - * + * * @param eventType the event type * @param topic the topic * @param payload the payload * @param source the source, can be null - * + * * @return the created event instance - * + * * @throws Exception if the creation of the event fails */ protected abstract Event createEventByType(String eventType, String topic, String payload, String source) @@ -78,9 +78,9 @@ protected abstract Event createEventByType(String eventType, String topic, Strin /** * Serializes the payload object into its equivalent Json representation. - * + * * @param payloadObject the payload object to serialize - * + * * @return a serialized Json representation */ protected static String serializePayload(Object payloadObject) { @@ -89,10 +89,10 @@ protected static String serializePayload(Object payloadObject) { /** * Deserializes the Json-payload into an object of the specified class. - * + * * @param payload the payload from which the object is to be deserialized * @param classOfPayload the class T of the payload object - * + * @param the type of the returned object * @return an object of type T from the payload */ protected static T deserializePayload(String payload, Class classOfPayload) { @@ -101,9 +101,9 @@ protected static T deserializePayload(String payload, Class classOfPayloa /** * Gets the elements of the topic (splitted by '/'). - * + * * @param topic the topic - * + * * @return the topic elements */ protected String[] getTopicElements(String topic) { diff --git a/bundles/core/org.eclipse.smarthome.core/src/main/java/org/eclipse/smarthome/core/storage/StorageService.java b/bundles/core/org.eclipse.smarthome.core/src/main/java/org/eclipse/smarthome/core/storage/StorageService.java index 8deb71ebf67..61061e07c37 100644 --- a/bundles/core/org.eclipse.smarthome.core/src/main/java/org/eclipse/smarthome/core/storage/StorageService.java +++ b/bundles/core/org.eclipse.smarthome.core/src/main/java/org/eclipse/smarthome/core/storage/StorageService.java @@ -13,8 +13,7 @@ * different {@link StorageService}s that store these key-value pairs * differently. One can think of e.g in-memory or in-database {@link Storage}s * and many more. This {@link StorageService} decides which kind of {@link Storage} is returned on request. It is meant - * to be injected into - * service consumers with the need for storing generic key-value pairs like the + * to be injected into service consumers with the need for storing generic key-value pairs like the * ManagedXXXProviders. * * @author Thomas.Eichstaedt-Engelen - Initial Contribution and API @@ -24,8 +23,7 @@ public interface StorageService { /** * Returns the {@link Storage} with the given {@code name}. If no {@link Storage} with this name exists a new - * initialized instance - * is returned. + * initialised instance is returned. * * @param name the name of the {@link StorageService} to return * @return a ready to use {@link Storage}, never {@code null} @@ -34,13 +32,11 @@ public interface StorageService { /** * Returns the {@link Storage} with the given {@code name} and a given {@link ClassLoader}. If no {@link Storage} - * with this name exists a new - * initialized instance is returned. + * with this name exists a new initialised instance is returned. * - * @param name - * the name of the {@link StorageService} to return - * @param classLoader - * the class loader which should be used by the {@link Storage} + * @param name the name of the {@link StorageService} to return + * @param classLoader the class loader which should be used by the {@link Storage} + * @param The type of the storage service * @return a ready to use {@link Storage}, never {@code null} */ Storage getStorage(String name, ClassLoader classLoader);