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

4
bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/AbstractDtoAttributeSelector.java
View File

@@ -22,7 +22,7 @@ import org.openhab.binding.deutschebahn.internal.timetable.dto.JaxbEntity;
import org.openhab.core.types.State;
/**
* Accessor for attribute value of an DTO-Object.
* Accessor for attribute value of a DTO-Object.
*
* @author Sönke Küper - Initial contribution.
*
@@ -41,7 +41,7 @@ public abstract class AbstractDtoAttributeSelector<DTO_TYPE extends JaxbEntity,
private final Function<VALUE_TYPE, List<String>> valueToList;
/**
* Creates an new {@link EventAttribute}.
* Creates a new {@link EventAttribute}.
*
* @param getter Function to get the raw value.
* @param setter Function to set the raw value.

2
bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/AttributeSelection.java
View File

@@ -20,7 +20,7 @@ import org.openhab.binding.deutschebahn.internal.timetable.dto.TimetableStop;
import org.openhab.core.types.State;
/**
* Selection of an attribute within an {@link TimetableStop} that provides a channel {@link State}.
* Selection of an attribute within a {@link TimetableStop} that provides a channel {@link State}.
*
* @author Sönke Küper - Initial contribution
*/

12
bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/DeutscheBahnTrainHandler.java
View File

@@ -31,9 +31,9 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Handler for an Train-Thing in DeutscheBahn Binding.
* Handler for a Train-Thing in DeutscheBahn Binding.
*
* Represents an Train that arrives / departs at the station selected by the DeutscheBahnTimetable-Bridge.
* Represents a Train that arrives / departs at the station selected by the DeutscheBahnTimetable-Bridge.
*
* @author Sönke Küper - Initial contribution
*/
@@ -49,7 +49,7 @@ public class DeutscheBahnTrainHandler extends BaseThingHandler {
private final AttributeSelection attributeSelection;
/**
* Creates an new ChannelWithConfig.
* Creates a new ChannelWithConfig.
*
* @param channelUid The UID of the channel
* @param attributeSelection The attribute that provides the state that will be displayed.
@@ -88,7 +88,7 @@ public class DeutscheBahnTrainHandler extends BaseThingHandler {
private final List<ChannelWithConfig> configuredChannels = new ArrayList<>();
/**
* Creates an new {@link DeutscheBahnTrainHandler}.
* Creates a new {@link DeutscheBahnTrainHandler}.
*/
public DeutscheBahnTrainHandler(Thing thing) {
super(thing);
@@ -123,7 +123,7 @@ public class DeutscheBahnTrainHandler extends BaseThingHandler {
}
/**
* Creates an {@link ChannelWithConfig} for an channel that represents an attribute of an
* Creates a {@link ChannelWithConfig} for a channel that represents an attribute of an
* {@link org.openhab.binding.deutschebahn.internal.timetable.dto.TripLabel}.
*/
private void createTripChannelConfiguration(Channel channel) {
@@ -141,7 +141,7 @@ public class DeutscheBahnTrainHandler extends BaseThingHandler {
}
/**
* Creates the {@link ChannelWithConfig} for an channel that represents an attribute of an
* Creates the {@link ChannelWithConfig} for a channel that represents an attribute of an
* {@link org.openhab.binding.deutschebahn.internal.timetable.dto.Event}.}
*/
private void createEventChannelConfiguration(EventType eventType, Channel channel) {

2
bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/EventAttribute.java
View File

@@ -215,7 +215,7 @@ public final class EventAttribute<VALUE_TYPE, STATE_TYPE extends State>
private static final SimpleDateFormat DATETIME_FORMAT = new SimpleDateFormat("yyMMddHHmm");
/**
* Creates an new {@link EventAttribute}.
* Creates a new {@link EventAttribute}.
*
* @param getter Function to get the raw value.
* @param setter Function to set the raw value.

2
bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/EventAttributeSelection.java
View File

@@ -36,7 +36,7 @@ public final class EventAttributeSelection implements AttributeSelection {
private final EventAttribute<?, ?> eventAttribute;
/**
* Creates an new {@link EventAttributeSelection}.
* Creates a new {@link EventAttributeSelection}.
*/
public EventAttributeSelection(EventType eventType, EventAttribute<?, ?> eventAttribute) {
this.eventType = eventType;

2
bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/EventType.java
View File

@@ -20,7 +20,7 @@ import org.openhab.binding.deutschebahn.internal.timetable.dto.Event;
import org.openhab.binding.deutschebahn.internal.timetable.dto.TimetableStop;
/**
* Type of an {@link Event} within an {@link TimetableStop}.
* Type of an {@link Event} within a {@link TimetableStop}.
*
* @author Sönke Küper - initial contribution
*/

6
bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/TripLabelAttribute.java
View File

@@ -27,7 +27,7 @@ import org.openhab.core.types.State;
import org.openhab.core.types.UnDefType;
/**
* Selection that returns the value of an {@link TripLabel}.
* Selection that returns the value of a {@link TripLabel}.
*
* chapter "1.2.7 TripLabel" in Technical Interface Description for external Developers
*
@@ -73,7 +73,7 @@ public final class TripLabelAttribute<VALUE_TYPE, STATE_TYPE extends State> exte
TripLabel::setO, StringType::new, TripLabelAttribute::singletonList, StringType.class);
/**
* Creates an new {@link TripLabelAttribute}.
* Creates a new {@link TripLabelAttribute}.
*
* @param getter Function to get the raw value.
* @param setter Function to set the raw value.
@@ -133,7 +133,7 @@ public final class TripLabelAttribute<VALUE_TYPE, STATE_TYPE extends State> exte
}
/**
* Returns an {@link TripLabelAttribute} for the given channel-name.
* Returns a {@link TripLabelAttribute} for the given channel-name.
*/
@Nullable
public static TripLabelAttribute<?, ?> getByChannelName(final String channelName) {

2
bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/AndPredicate.java
View File

@@ -27,7 +27,7 @@ public final class AndPredicate implements TimetableStopPredicate {
private final TimetableStopPredicate second;
/**
* Creates an new {@link AndPredicate}.
* Creates a new {@link AndPredicate}.
*/
public AndPredicate(TimetableStopPredicate first, TimetableStopPredicate second) {
this.first = first;

4
bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/ChannelNameEquals.java
View File

@@ -34,7 +34,7 @@ public final class ChannelNameEquals extends FilterToken {
private final String channelGroup;
/**
* Creates an new {@link ChannelNameEquals}.
* Creates a new {@link ChannelNameEquals}.
*/
public ChannelNameEquals(int position, String channelGroup, String channelName, Pattern filterPattern) {
super(position);
@@ -75,7 +75,7 @@ public final class ChannelNameEquals extends FilterToken {
}
/**
* Maps this into an {@link TimetableStopByStringEventAttributeFilter}.
* Maps this into a {@link TimetableStopByStringEventAttributeFilter}.
*/
public TimetableStopByStringEventAttributeFilter mapToPredicate() throws FilterParserException {
return new TimetableStopByStringEventAttributeFilter(mapAttributeSelection(), filterValue);

4
bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/FilterParser.java
View File

@@ -18,7 +18,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
/**
* Parses an {@link FilterToken}-Sequence into a {@link TimetableStopPredicate}.
* Parses a {@link FilterToken}-Sequence into a {@link TimetableStopPredicate}.
*
* @author Sönke Küper - Initial contribution.
*/
@@ -287,7 +287,7 @@ public final class FilterParser {
}
/**
* Parses the given {@link FilterToken} into an {@link TimetableStopPredicate}.
* Parses the given {@link FilterToken} into a {@link TimetableStopPredicate}.
*/
public static TimetableStopPredicate parse(final List<FilterToken> tokens) throws FilterParserException {
State state = new InitialState();

2
bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/FilterParserException.java
View File

@@ -25,7 +25,7 @@ public final class FilterParserException extends Exception {
private static final long serialVersionUID = 3104578924298682889L;
/**
* Creates an new {@link FilterParserException}.
* Creates a new {@link FilterParserException}.
*/
public FilterParserException(String message) {
super(message);

6
bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/FilterScanner.java
View File

@@ -149,7 +149,7 @@ public final class FilterScanner {
private final String channelGroup;
/**
* Creates an new {@link ExpectQuotesState}.
* Creates a new {@link ExpectQuotesState}.
*/
public ExpectQuotesState(int startPosition, final String channelGroup, String channelName) {
this.startPosition = startPosition;
@@ -182,7 +182,7 @@ public final class FilterScanner {
private final StringBuilder filterValue;
/**
* Creates an new {@link FilterValueState}.
* Creates a new {@link FilterValueState}.
*/
public FilterValueState(int startPosition, String channelGroup, String channelName) {
this.startPosition = startPosition;
@@ -216,7 +216,7 @@ public final class FilterScanner {
private List<FilterToken> result;
/**
* Creates an new {@link FilterScanner}.
* Creates a new {@link FilterScanner}.
*/
public FilterScanner() {
this.result = new ArrayList<>();

2
bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/FilterToken.java
View File

@@ -25,7 +25,7 @@ public abstract class FilterToken {
private final int position;
/**
* Creates an new {@link FilterToken}.
* Creates a new {@link FilterToken}.
*/
public FilterToken(int position) {
this.position = position;

2
bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/OperatorToken.java
View File

@@ -23,7 +23,7 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
public abstract class OperatorToken extends FilterToken {
/**
* Creates an new {@link OperatorToken}.
* Creates a new {@link OperatorToken}.
*/
public OperatorToken(int position) {
super(position);

2
bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/OrPredicate.java
View File

@@ -27,7 +27,7 @@ final class OrPredicate implements TimetableStopPredicate {
private final TimetableStopPredicate second;
/**
* Creates an new {@link OrPredicate}.
* Creates a new {@link OrPredicate}.
*/
public OrPredicate(TimetableStopPredicate first, TimetableStopPredicate second) {
this.first = first;

4
bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/filter/TimetableStopByStringEventAttributeFilter.java
View File

@@ -20,7 +20,7 @@ import org.openhab.binding.deutschebahn.internal.AttributeSelection;
import org.openhab.binding.deutschebahn.internal.timetable.dto.TimetableStop;
/**
* Abstract predicate that filters timetable stops by an selected attribute of an {@link TimetableStop}.
* Abstract predicate that filters timetable stops by a selected attribute of a {@link TimetableStop}.
*
* If value has multiple values (for example stations on the planned-path) the predicate will return <code>true</code>,
* if at least one value matches the given filter.
@@ -34,7 +34,7 @@ public final class TimetableStopByStringEventAttributeFilter implements Timetabl
private final Pattern filter;
/**
* Creates an new {@link TimetableStopByStringEventAttributeFilter}.
* Creates a new {@link TimetableStopByStringEventAttributeFilter}.
*/
TimetableStopByStringEventAttributeFilter(final AttributeSelection attributeSelection, final Pattern filter) {
this.attributeSelection = attributeSelection;

4
bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/timetable/TimetableLoader.java
View File

@@ -38,7 +38,7 @@ import org.openhab.binding.deutschebahn.internal.timetable.dto.TimetableStop;
import org.openhab.core.library.types.DateTimeType;
/**
* Helper for loading the required amount of {@link TimetableStop} via an {@link TimetablesV1Api}.
* Helper for loading the required amount of {@link TimetableStop} via a {@link TimetablesV1Api}.
* This consists of a series of calls.
*
* @author Sönke Küper - initial contribution
@@ -73,7 +73,7 @@ public final class TimetableLoader {
private Date lastRequestedChanges;
/**
* Creates an new {@link TimetableLoader}.
* Creates a new {@link TimetableLoader}.
*
* @param api {@link TimetablesV1Api} to use.
* @param stopPredicate Filter for selection of loaded {@link TimetableStop}.

2
bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/timetable/TimetableStopComparator.java
View File

@@ -32,7 +32,7 @@ public class TimetableStopComparator implements Comparator<TimetableStop> {
private final EventType eventSelection;
/**
* Creates an new {@link TimetableStopComparator} that sorts {@link TimetableStop} according the Event selected
* Creates a new {@link TimetableStopComparator} that sorts {@link TimetableStop} according the Event selected
* selected by the given {@link EventType}.
*/
public TimetableStopComparator(EventType eventSelection) {

2
bundles/org.openhab.binding.deutschebahn/src/main/java/org/openhab/binding/deutschebahn/internal/timetable/TimetablesV1ApiFactory.java
View File

@@ -26,7 +26,7 @@ import org.openhab.binding.deutschebahn.internal.timetable.TimetablesV1Impl.Http
public interface TimetablesV1ApiFactory {
/**
* Creates an new instance of the {@link TimetablesV1Api}.
* Creates a new instance of the {@link TimetablesV1Api}.
*/
public abstract TimetablesV1Api create(final String clientId, final String clientSecret,
final HttpCallable httpCallable) throws JAXBException;

4
bundles/org.openhab.binding.deutschebahn/src/test/java/org/openhab/binding/deutschebahn/internal/timetable/TimetablesV1ApiStub.java
View File

@@ -36,14 +36,14 @@ public final class TimetablesV1ApiStub implements TimetablesV1Api {
}
/**
* Creates an new {@link TimetablesV1ApiStub}, that returns the given result.
* Creates a new {@link TimetablesV1ApiStub}, that returns the given result.
*/
public static TimetablesV1ApiStub createWithResult(Timetable timetable) {
return new TimetablesV1ApiStub(timetable);
}
/**
* Creates an new {@link TimetablesV1ApiStub} that throws an Exception.
* Creates a new {@link TimetablesV1ApiStub} that throws an Exception.
*/
public static TimetablesV1ApiStub createWithException() {
return new TimetablesV1ApiStub(null);

6
bundles/org.openhab.binding.deutschebahn/src/test/java/org/openhab/binding/deutschebahn/internal/timetable/TimetablesV1ImplTestHelper.java
View File

@@ -20,7 +20,7 @@ import java.net.URL;
import org.eclipse.jdt.annotation.NonNullByDefault;
/**
* Helper interface for jUnit Tests to provide an {@link TimetablesApiTestModule}.
* Helper interface for jUnit Tests to provide a {@link TimetablesApiTestModule}.
*
* @author Sönke Küper - initial contribution.
*/
@@ -33,7 +33,7 @@ public interface TimetablesV1ImplTestHelper {
public static final String CLIENT_SECRET = "354c8161cd7fb0936c840240280c131e";
/**
* Creates an {@link TimetablesApiTestModule} that uses http response data from file system.
* Creates a {@link TimetablesApiTestModule} that uses http response data from file system.
* Uses default-testdata from directory /timetablesData
*/
public default TimetablesApiTestModule createApiWithTestdata() throws Exception {
@@ -41,7 +41,7 @@ public interface TimetablesV1ImplTestHelper {
}
/**
* Creates an {@link TimetablesApiTestModule} that uses http response data from file system.
* Creates a {@link TimetablesApiTestModule} that uses http response data from file system.
*
* @param dataDirectory Directory within test-resources containing the stub-data.
*/