Skip to content

Commit

Permalink
Fix a/an typos (#3181)
Browse files Browse the repository at this point in the history
* Typos a/an
* Fix typo generation in generateTagClasses.groovy

Signed-off-by: Wouter Born <github@maindrain.net>
  • Loading branch information
dilyanpalauzov authored Nov 29, 2022
1 parent d96e5d5 commit e556fdf
Show file tree
Hide file tree
Showing 93 changed files with 116 additions and 114 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ private Addon convertTopicItemToAddon(DiscourseTopicItem topic, List<DiscourseUs
"posts_count", postsCount, //
"tags", tags.toArray(String[]::new));

// try to use an handler to determine if the add-on is installed
// try to use a handler to determine if the add-on is installed
boolean installed = addonHandlers.stream()
.anyMatch(handler -> handler.supports(type, contentType) && handler.isInstalled(id));

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@
import org.slf4j.LoggerFactory;

/**
* This is an AudioStream from an URL. Note that some sinks, like Sonos, can directly handle URL
* based streams, and therefore can/should call getURL() to get an direct reference to the URL.
* This is an AudioStream from a URL. Note that some sinks, like Sonos, can directly handle URL
* based streams, and therefore can/should call getURL() to get a direct reference to the URL.
*
* @author Karel Goderis - Initial contribution
* @author Kai Kreuzer - Refactored to not require a source
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ public void run() {
}

/**
* Converts a org.openhab.core.audio.AudioFormat
* Converts an org.openhab.core.audio.AudioFormat
* to a javax.sound.sampled.AudioFormat
*
* @param audioFormat The AudioFormat to convert
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import org.openhab.core.events.AbstractEvent;

/**
* This is an {@link Event} that is sent when a web client should play an audio stream from an url.
* This is an {@link Event} that is sent when a web client should play an audio stream from a url.
*
* @author Kai Kreuzer - Initial contribution and API
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
import org.slf4j.LoggerFactory;

/**
* This is an ModuleHandler implementation for Actions that play a sound file from the file system.
* This is a ModuleHandler implementation for Actions that play a sound file from the file system.
*
* @author Kai Kreuzer - Initial contribution
* @author Christoph Weitkamp - Added parameter volume
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
import org.openhab.core.voice.VoiceManager;

/**
* This is an ModuleHandler implementation for Actions that trigger a TTS output through "say".
* This is a ModuleHandler implementation for Actions that trigger a TTS output through "say".
*
* @author Kai Kreuzer - Initial contribution
* @author Christoph Weitkamp - Added parameter volume
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
import org.openhab.core.config.core.Configuration;

/**
* convenience Rule class with an action handler. This allows to define Rules which have a execution block.
* convenience Rule class with an action handler. This allows to define Rules which have an execution block.
*
* @author Simon Merschjohann - Initial contribution
* @author Kai Kreuzer - made it implement Rule
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
import org.openhab.core.common.registry.RegistryChangeListener;

/**
* This class is responsible to provide a {@link RegistryChangeListener} logic. A instance of it is added to
* This class is responsible to provide a {@link RegistryChangeListener} logic. An instance of it is added to
* {@link RuleRegistry} service, to listen for changes when a single {@link Rule} has been added, updated, enabled,
* disabled or removed and to involve Rule Engine to process these changes. Also to send a {@code run} command
* for a single {@link Rule} to the Rule Engine.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public final class RuleExecution implements Comparable<RuleExecution> {
private final Rule rule;

/**
* Creates an new {@link RuleExecution}.
* Creates a new {@link RuleExecution}.
*
* @param date The time when the rule will be executed.
* @param rule The rule that will be executed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
import org.openhab.core.common.registry.RegistryChangeListener;

/**
* This class is responsible to provide a {@link RegistryChangeListener} logic. A instance of it is added to
* This class is responsible to provide a {@link RegistryChangeListener} logic. An instance of it is added to
* {@link RuleRegistry} service, to listen for changes when a single {@link Rule} has been added, updated, enabled,
* disabled or removed and to involve Rule Engine to process these changes. Also to send a {@code run} command
* for a single {@link Rule} to the Rule Engine.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import org.eclipse.jdt.annotation.NonNullByDefault;

/**
* {@link ConditionHandler} that evaluates, if the current time satisfies an specified condition.
* {@link ConditionHandler} that evaluates, if the current time satisfies a specified condition.
*
* @author Sönke Küper - Initial contribution
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public final class Connection {
/**
* This constructor is responsible for creation of connections between modules in the rule.
*
* @param inputName is an unique id of the {@code Input} in scope of the {@link Module}.
* @param inputName is a unique id of the {@code Input} in scope of the {@link Module}.
* @param reference the reference tokens of this connection
*/
public Connection(String inputName, String reference) {
Expand All @@ -52,9 +52,9 @@ public Connection(String inputName, String reference) {
/**
* This constructor is responsible for creation of connections between modules in the rule.
*
* @param inputName is an unique name of the {@code Input} in scope of the {@link Module}.
* @param outputModuleId is an unique id of the {@code Module} in scope of the {@link Rule}.
* @param outputName is an unique name of the {@code Output} in scope of the {@link Module}.
* @param inputName is a unique name of the {@code Input} in scope of the {@link Module}.
* @param outputModuleId is a unique id of the {@code Module} in scope of the {@link Rule}.
* @param outputName is a unique name of the {@code Output} in scope of the {@link Module}.
* @param reference the reference tokens of this connection
*/
public Connection(String inputName, @Nullable String outputModuleId, @Nullable String outputName,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ final class RuleExecutionSimulator {
private final RuleEngineImpl ruleEngine;

/**
* Constructs an new {@link RuleExecutionSimulator}.
* Constructs a new {@link RuleExecutionSimulator}.
*/
public RuleExecutionSimulator(RuleRegistry ruleRegistry, RuleEngineImpl ruleEngine) {
this.ruleRegistry = ruleRegistry;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ public String execute() {
* This method serves to create an {@link URL} object or {@link File} object from a string that is passed as
* a parameter of the command. From the {@link File} object the URL is constructed.
*
* @param parameterValue is a string that is passed as parameter of the command and it supposed to be an URL
* @param parameterValue is a string that is passed as parameter of the command and it supposed to be a URL
* representation.
* @return an {@link URL} object created from the string that is passed as parameter of the command or <b>null</b>
* if either no legal protocol could be found in the specified string or the string could not be parsed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ public String execute() {
* This method serves to create an {@link URL} object or {@link File} object from a string that is passed as
* a parameter of the command. From the {@link File} object the URL is constructed.
*
* @param parameterValue is a string that is passed as parameter of the command and it supposed to be an URL
* @param parameterValue is a string that is passed as parameter of the command and it supposed to be a URL
* representation.
* @return an {@link URL} object created from the string that is passed as parameter of the command or <b>null</b>
* if either no legal protocol could be found in the specified string or the string could not be parsed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
import org.slf4j.LoggerFactory;

/**
* This is an ModuleHandler implementation for trigger channels with specific events
* This is a ModuleHandler implementation for trigger channels with specific events
*
* @author Stefan Triller - Initial contribution
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
import org.slf4j.LoggerFactory;

/**
* This is an ModuleHandler implementation for Triggers which trigger the rule
* This is a ModuleHandler implementation for Triggers which trigger the rule
* based on a {@link org.openhab.core.library.types.DateTimeType} stored in an item
*
* @author Jan N. Klug - Initial contribution
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
import org.slf4j.LoggerFactory;

/**
* This is an ModuleHandler implementation for Triggers which trigger the rule
* This is a ModuleHandler implementation for Triggers which trigger the rule
* based on a cron expression. The cron expression can be set with the
* configuration.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
import org.slf4j.LoggerFactory;

/**
* This is the implementation of a event condition which checks if inputs matches configured values.
* This is the implementation of an event condition which checks if inputs matches configured values.
*
* @author Benedikt Niehues - Initial contribution
* @author Kai Kreuzer - refactored and simplified customized module handling
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@
import org.slf4j.LoggerFactory;

/**
* This is an ModuleHandler implementation for Triggers which trigger the rule
* This is a ModuleHandler implementation for Triggers which trigger the rule
* if an event occurs. The eventType, eventSource and topic can be set with the
* configuration. It is an generic approach which makes it easier to specify
* configuration. It is a generic approach which makes it easier to specify
* more concrete event based triggers with the composite module approach of the
* automation component. Each GenericTriggerHandler instance registers as
* EventSubscriber, so the dispose method must be called for unregistering the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
import org.slf4j.LoggerFactory;

/**
* This is an ModuleHandler implementation for Triggers which trigger the rule
* This is a ModuleHandler implementation for Triggers which trigger the rule
* if a member of an item group receives a command.
* The group name and command value can be set with the configuration.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
import org.slf4j.LoggerFactory;

/**
* This is an ModuleHandler implementation for Triggers which trigger the rule
* This is a ModuleHandler implementation for Triggers which trigger the rule
* if state event of a member of an item group occurs.
* The group name and state value can be set with the configuration.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
import org.slf4j.LoggerFactory;

/**
* This is an ModuleHandler implementation for Triggers which trigger the rule
* This is a ModuleHandler implementation for Triggers which trigger the rule
* if an item receives a command. The eventType and command value can be set with the
* configuration.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
import org.slf4j.LoggerFactory;

/**
* This is an ModuleHandler implementation for Triggers which trigger the rule
* This is a ModuleHandler implementation for Triggers which trigger the rule
* if an item state event occurs. The eventType and state value can be set with the
* configuration.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
import org.slf4j.LoggerFactory;

/**
* This is an ModuleHandler implementation for Triggers which trigger the rule
* This is a ModuleHandler implementation for Triggers which trigger the rule
* at a specific time (format 'hh:mm').
*
* @author Kai Kreuzer - Initial contribution
Expand Down Expand Up @@ -57,7 +57,7 @@ public TimeOfDayTriggerHandler(Trigger module, CronScheduler scheduler) {
}

/**
* Creates an cron-Expression from the configured time.
* Creates a cron-Expression from the configured time.
*/
private static String buildExpressionFromConfigurationTime(String time) {
try {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ public Input(String name, String type, String label, String description, Set<Str
/**
* Gets the name of Input. It must be unique in scope of the {@link Rule}.
*
* @return name is an unique identifier of the Input.
* @return name is a unique identifier of the Input.
*/
public String getName() {
return name;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* defines the meta-information needed for creation of a {@link Module} instance which is a building block for a
* {@link Rule}. The meta-information describes the {@link Configuration} of a {@link Module} providing list with
* {@link ConfigDescriptionParameter}s, {@link Input}s and {@link Output}s of a {@link Module}. Each {@link ModuleType}
* instance owns an unique id which is used as reference in the {@link Module}s, to find their meta-information.
* instance owns a unique id which is used as reference in the {@link Module}s, to find their meta-information.
* <p>
* Whether the {@link ModuleType}s can be used by anyone, depends from their {@link Visibility} value, but they can be
* modified only by their creator.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public interface ModuleTypeRegistry extends Registry<ModuleType, String> {
/**
* Gets the localized {@link ModuleType} by specified UID and locale.
*
* @param moduleTypeUID the an unique id in scope of registered {@link ModuleType}s.
* @param moduleTypeUID the a unique id in scope of registered {@link ModuleType}s.
* @param locale used for localization of the {@link ModuleType}.
* @param <T> the type of the required object.
* @return the desired {@link ModuleType} instance or {@code null} if a module type with such UID does not exist or
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
public class Output {

/**
* is an unique name of the {@code Output} in scope of the {@link Module}.
* is a unique name of the {@code Output} in scope of the {@link Module}.
*/
private String name;

Expand Down Expand Up @@ -112,7 +112,7 @@ public Output(String name, String type) {
* @param name a unique name of the {@code Output}.
* @param type the type of the output data.
* @param label a single word description of the {@code Output}.
* @param description is an user friendly description of the {@code Output}.
* @param description is a 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.<br>
Expand Down Expand Up @@ -147,7 +147,7 @@ public Output(String name, String type, String label, String description, Set<St
* This method is used for getting the name of {@code Output}. It must be unique in
* scope of {@link Rule}.
*
* @return name is an unique identifier of the {@code Output}.
* @return name is a unique identifier of the {@code Output}.
*/
public String getName() {
return name;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,7 @@ public static String[] splitReferenceToTokens(String reference) throws IllegalAr
* {@link SecurityManager#checkPackageAccess s.checkPackageAccess()} denies
* access to the package of this class</li>
* </ul>
* @throws ArrayIndexOutOfBoundsException if one of the tokens represent a invalid index in the list.
* @throws ArrayIndexOutOfBoundsException if one of the tokens represent an invalid index in the list.
* @throws NullPointerException if the path references something in a non existing map entry.
* @throws NumberFormatException if one of the tokens is accessing a list and the token that represent the
* index can't be converted to integer.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ public static void applyDefaultConfiguration(Configuration configuration,
* @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
* @throws IllegalArgumentException if an invalid type has been given
*/
public static Object normalizeType(Object value, @Nullable ConfigDescriptionParameter configDescriptionParameter) {
if (configDescriptionParameter != null) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ public interface DiscoveryResult {
/**
* Returns the representation property of this result object.
* <p>
* The representation property represents an unique human and/or machine readable identifier of the thing that was
* The representation property represents a unique human and/or machine readable identifier of the thing that was
* discovered. Its actual value can be retrieved from the {@link DiscoveryResult#getProperties()} map. Such unique
* identifiers are typically the <code>ipAddress</code>, the <code>macAddress</code> or the
* <code>serialNumber</code> of the discovered thing.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ public interface DiscoveryServiceRegistry {
* Forces the associated {@link DiscoveryService}s to start a discovery for
* all thing types of the given binding id.
* <p>
* Returns {@code true}, if a at least one {@link DiscoveryService} could be found and forced to start a discovery,
* Returns {@code true}, if at least one {@link DiscoveryService} could be found and forced to start a discovery,
* otherwise {@code false}.
*
* @param bindingId the binding id pointing to one or more discovery services to
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
import org.openhab.core.thing.ThingUID;

/**
* The {@link DiscoveryResultDTOMapper} is an utility class to map discovery results into discovery result transfer
* The {@link DiscoveryResultDTOMapper} is a utility class to map discovery results into discovery result transfer
* objects.
*
* @author Stefan Bussweiler - Initial contribution
Expand Down
Loading

0 comments on commit e556fdf

Please sign in to comment.