public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Typos a/an (#13812)

Browse Source
This commit is contained in:
Дилян Палаузов
2022-12-01 15:30:50 +02:00
committed by GitHub
parent 622654ff1d
commit 78534e8106
105 changed files with 144 additions and 143 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/event/EventHandler.java
View File

@@ -34,7 +34,7 @@ import org.openhab.binding.digitalstrom.internal.lib.event.types.EventItem;
public interface EventHandler {
/**
* Handles a {@link EventItem} e.g. which was detected by the {@link EventListener}.
* Handles an {@link EventItem} e.g. which was detected by the {@link EventListener}.
*
* @param eventItem to handle
*/
@@ -63,14 +63,14 @@ public interface EventHandler {
String getUID();
/**
* Sets a {@link EventListener} to this {@link EventHandler}.
* Sets an {@link EventListener} to this {@link EventHandler}.
*
* @param eventListener to set
*/
void setEventListener(EventListener eventListener);
/**
* Unsets a {@link EventListener} to this {@link EventHandler}.
* Unsets an {@link EventListener} to this {@link EventHandler}.
*
* @param eventListener to unset
*/

8
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/event/EventListener.java
View File

@@ -39,7 +39,7 @@ import com.google.gson.JsonObject;
* added {@link EventHandler} about the detected events, if it supports the event-type.<br>
* You can add {@link EventHandler}'s through the constructors or the methods {@link #addEventHandler(EventHandler)} and
* {@link #addEventHandlers(List)}.<br>
* You can also delete a {@link EventHandler} though the method {@link #removeEventHandler(EventHandler)}.<br>
* You can also delete an {@link EventHandler} though the method {@link #removeEventHandler(EventHandler)}.<br>
* If the {@link EventListener} is started, both methods subscribe respectively unsubscribe the event-types of the
* {@link EventHandler}/s automatically.<br>
* If you want to dynamically subscribe event-types, e.g. because a configuration has changed and a
@@ -106,7 +106,7 @@ public class EventListener {
}
/**
* Creates a new {@link EventListener} without a {@link EventHandler}<br>
* Creates a new {@link EventListener} without an {@link EventHandler}<br>
* <br>
* To get notified by events you have to call {@link #start()} and {@link #addEventHandler(EventHandler)} or
* {@link #addEventHandlers(List)}.
@@ -188,7 +188,7 @@ public class EventListener {
}
/**
* Adds a {@link EventHandler}'s and subscribe the supported event-types, if the
* Adds an {@link EventHandler}'s and subscribe the supported event-types, if the
* {@link EventListener} is started and the event-types are not already subscribed.<br>
* <br>
* <b>Note:</b><br>
@@ -217,7 +217,7 @@ public class EventListener {
}
/**
* Remove a {@link EventHandler} and unsubscribes the supported event-types, if the
* Remove an {@link EventHandler} and unsubscribes the supported event-types, if the
* {@link EventListener} is started and no other {@link EventHandler} needed the event-types.
*
* @param eventHandler to remove

4
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/event/types/EventItem.java
View File

@@ -34,7 +34,7 @@ public interface EventItem {
/**
* Returns {@link HashMap} with the properties fiels of this {@link EventItem}.
* The key is a {@link EventResponseEnum} and represents the property name
* The key is an {@link EventResponseEnum} and represents the property name
* and the value is the property value.
*
* @return the properties of this {@link EventItem}
@@ -43,7 +43,7 @@ public interface EventItem {
/**
* Returns {@link HashMap} with the source fields of this {@link EventItem}.
* The key is a {@link EventResponseEnum} and represents the property name
* The key is an {@link EventResponseEnum} and represents the property name
* and the value is the property value.
*
* @return the properties of this {@link EventItem}

6
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/listener/SceneStatusListener.java
View File

@@ -15,7 +15,7 @@ package org.openhab.binding.digitalstrom.internal.lib.listener;
import org.openhab.binding.digitalstrom.internal.lib.structure.scene.InternalScene;
/**
* The {@link SceneStatusListener} is notified, if a {@link InternalScene} status has changed or a
* The {@link SceneStatusListener} is notified, if an {@link InternalScene} status has changed or a
* {@link InternalScene} has been removed or added.
*
* <p>
@@ -43,14 +43,14 @@ public interface SceneStatusListener {
void onSceneStateChanged(boolean newState);
/**
* This method is called whenever a {@link InternalScene} is removed.
* This method is called whenever an {@link InternalScene} is removed.
*
* @param scene that was removed
*/
void onSceneRemoved(InternalScene scene);
/**
* This method is called whenever a {@link InternalScene} is added.
* This method is called whenever an {@link InternalScene} is added.
*
* @param scene that was added
*/

6
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/SceneManager.java
View File

@@ -36,7 +36,7 @@ import org.openhab.binding.digitalstrom.internal.lib.structure.scene.InternalSce
* , {@link #callDeviceScene(String, Short)} etc. can be used.
*
* <p>
* If you call the {@link #start()} method a {@link EventListener} will be started to handle scene calls and undos from
* If you call the {@link #start()} method an {@link EventListener} will be started to handle scene calls and undos from
* the outside.
*
* @author Michael Ochel - Initial contribution
@@ -54,7 +54,7 @@ public interface SceneManager extends EventHandler {
void callInternalScene(InternalScene scene);
/**
* Activates a {@link InternalScene} with the given id, if it exists. Otherwise a new
* Activates an {@link InternalScene} with the given id, if it exists. Otherwise a new
* {@link InternalScene} will be created and activated, if it is a callable scene.
*
* @param sceneID of the scene to call
@@ -86,7 +86,7 @@ public interface SceneManager extends EventHandler {
void undoInternalScene(InternalScene scene);
/**
* Deactivates a {@link InternalScene} with the given sceneID, if it exists. Otherwise a new
* Deactivates an {@link InternalScene} with the given sceneID, if it exists. Otherwise a new
* {@link InternalScene} will be created and deactivated, if it is a callable scene.
*
* @param sceneID of the scene to undo

2
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/impl/SceneManagerImpl.java
View File

@@ -97,7 +97,7 @@ public class SceneManagerImpl implements SceneManager {
/**
* Same constructor like {@link #SceneManagerImpl(ConnectionManager, StructureManager, ManagerStatusListener)}, but
* a {@link EventListener} can be set, too.
* an {@link EventListener} can be set, too.
*
* @param connectionManager (must not be null)
* @param structureManager (must not be null)

4
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/impl/StructureManagerImpl.java
View File

@@ -199,8 +199,8 @@ public class StructureManagerImpl implements StructureManager {
}
/**
* This method build the digitalSTROM structure as an {@link HashMap} with the zone id as key
* and an {@link HashMap} as value. This {@link HashMap} has the group id as key and a {@link List}
* This method build the digitalSTROM structure as a {@link HashMap} with the zone id as key
* and a {@link HashMap} as value. This {@link HashMap} has the group id as key and a {@link List}
* with all digitalSTROM {@link Device}s.<br>
* <br>
* <b>Note:</b> the zone id 0 is the broadcast address and the group id 0, too.

3
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/manager/impl/TemperatureControlManager.java
View File

@@ -37,7 +37,8 @@ import org.slf4j.LoggerFactory;
/**
* The {@link TemperatureControlManager} is responsible for handling the zone temperature control of the digitalSTROM
* zones. For that it implements a {@link EventHandler} to get informed by control changes, like the target temperature.
* zones. For that it implements an {@link EventHandler} to get informed by control changes, like the target
* temperature.
* It also implement the {@link TemperatureControlSensorTransmitter}, so the zone temperature can be set through this
* class. <br>
* <br>

2
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/DsAPI.java
View File

@@ -743,7 +743,7 @@ public interface DsAPI {
* operation mode, see
* {@link OperationModes}.<br>
* To set the values a {@link List} with an object array has to be set as controlVlaues parameter. The 1th field has
* to be a {@link String} for the {@link OperationModes} name and the 2nd field has to be a {@link Integer} for the
* to be a {@link String} for the {@link OperationModes} name and the 2nd field has to be an {@link Integer} for the
* new value. If the control mode is {@link ControlModes#PID_CONTROL} it is the nominal temperature, otherwise it is
* the control valve value.
*

2
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/serverconnection/impl/JSONResponseHandler.java
View File

@@ -21,7 +21,7 @@ import com.google.gson.JsonParseException;
import com.google.gson.JsonParser;
/**
* The {@link JSONResponseHandler} checks an digitalSTROM-JSON response and can parse it to an {@link JsonObject}.
* The {@link JSONResponseHandler} checks an digitalSTROM-JSON response and can parse it to a {@link JsonObject}.
*
* @author Alexander Betker - Initial contribution
* @author Alex Maier - Initial contribution

2
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/Device.java
View File

@@ -773,7 +773,7 @@ public interface Device extends GeneralDeviceInformation {
boolean isSensorEchoBoxEnabled();
/**
* Sets the {@link DeviceSensorValue} through a {@link EventItem} of the type
* Sets the {@link DeviceSensorValue} through an {@link EventItem} of the type
* {@link EventNames#DEVICE_SENSOR_VALUE}.
*
* @param event of the sensor update

2
bundles/org.openhab.binding.digitalstrom/src/main/java/org/openhab/binding/digitalstrom/internal/lib/structure/devices/impl/DeviceImpl.java
View File

@@ -1679,7 +1679,7 @@ public class DeviceImpl extends AbstractGeneralDeviceInformations implements Dev
}
/**
* if an {@link DeviceStatusListener} is registered inform him about the new
* if a {@link DeviceStatusListener} is registered inform him about the new
* state otherwise do nothing.
*
* @param deviceStateUpdate