mirror of
https://github.com/danieldemus/openhab-core.git
synced 2025-01-25 11:45:49 +01:00
Remove @since JavaDoc tags (#1102)
Signed-off-by: Wouter Born <github@maindrain.net>
This commit is contained in:
Wouter Born
Kai Kreuzer
parent
c31a5aa7ef
commit
7d3c5a1874
@ -22,7 +22,6 @@ import org.openhab.core.binding.BindingProvider;
|
||||
* taken into account.
|
||||
*
|
||||
* @author Thomas.Eichstaedt-Engelen
|
||||
* @since 0.9.1
|
||||
*/
|
||||
public interface AutoUpdateBindingProvider extends BindingProvider {
|
||||
|
||||
|
||||
@ -22,7 +22,6 @@ import org.slf4j.LoggerFactory;
|
||||
* @author Thomas.Eichstaedt-Engelen
|
||||
* @author Kai Kreuzer
|
||||
*
|
||||
* @since 0.6.0
|
||||
*/
|
||||
public abstract class AbstractActiveBinding<P extends BindingProvider> extends AbstractBinding<P> {
|
||||
|
||||
|
||||
@ -25,7 +25,6 @@ import org.openhab.core.types.State;
|
||||
*
|
||||
* @author Thomas.Eichstaedt-Engelen
|
||||
* @author Kai Kreuzer
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public abstract class AbstractBinding<P extends BindingProvider> extends AbstractEventSubscriber
|
||||
implements BindingChangeListener {
|
||||
|
||||
@ -17,7 +17,6 @@ package org.openhab.core.binding;
|
||||
* {@link BindingProvider} about changes in the binding configuration.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.3.0
|
||||
*/
|
||||
public interface BindingChangeListener {
|
||||
|
||||
|
||||
@ -17,7 +17,6 @@ package org.openhab.core.binding;
|
||||
* used as binding configurations.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.6.0
|
||||
*
|
||||
*/
|
||||
public interface BindingConfig {
|
||||
|
||||
@ -17,7 +17,6 @@ import java.util.Collection;
|
||||
/**
|
||||
* @author Thomas.Eichstaedt-Engelen
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.6.0
|
||||
*/
|
||||
public interface BindingProvider {
|
||||
|
||||
|
||||
@ -16,7 +16,6 @@ package org.openhab.core.events;
|
||||
* This interface defines constants required for using the OSGi Event Admin service.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.1.0
|
||||
*/
|
||||
public interface EventConstants {
|
||||
|
||||
|
||||
@ -19,7 +19,6 @@ import org.openhab.core.types.State;
|
||||
* An EventPublisher is used to send commands or status updates to the openHAB event bus.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.1.0
|
||||
*/
|
||||
public interface EventPublisher {
|
||||
|
||||
|
||||
@ -19,7 +19,6 @@ import org.openhab.core.types.State;
|
||||
* An EventSubscriber receives events from the openHAB event bus for further processing.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.1.0
|
||||
*/
|
||||
public interface EventSubscriber {
|
||||
|
||||
|
||||
@ -30,7 +30,6 @@ import org.openhab.core.types.UnDefType;
|
||||
* or notifying listeners.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.1.0
|
||||
*
|
||||
*/
|
||||
abstract public class GenericItem implements Item {
|
||||
|
||||
@ -22,7 +22,6 @@ import org.openhab.core.types.UnDefType;
|
||||
* out of the states of all its member items.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.7.0
|
||||
*
|
||||
*/
|
||||
abstract public interface GroupFunction {
|
||||
@ -49,7 +48,6 @@ abstract public interface GroupFunction {
|
||||
* have the same state. If this is the case, this state is returned, otherwise UNDEF is returned.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.7.0
|
||||
*
|
||||
*/
|
||||
static class Equality implements GroupFunction {
|
||||
|
||||
@ -16,7 +16,6 @@ package org.openhab.core.items;
|
||||
* This Factory creates concrete instances of the known ItemTypes.
|
||||
*
|
||||
* @author Thomas.Eichstaedt-Engelen
|
||||
* @since 0.9.0
|
||||
*/
|
||||
public interface ItemFactory {
|
||||
|
||||
|
||||
@ -17,7 +17,6 @@ package org.openhab.core.items;
|
||||
* related to item lookups in the item registry.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.1.0
|
||||
*
|
||||
*/
|
||||
public abstract class ItemLookupException extends Exception {
|
||||
|
||||
@ -19,7 +19,6 @@ import java.util.Collection;
|
||||
* an item. The list of matching items must be made available through this exception.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.1.0
|
||||
*
|
||||
*/
|
||||
public class ItemNotUniqueException extends ItemLookupException {
|
||||
|
||||
@ -20,7 +20,6 @@ import java.util.Collection;
|
||||
* they can be derived from some dynamic logic.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.1.0
|
||||
*
|
||||
*/
|
||||
public interface ItemProvider {
|
||||
|
||||
@ -23,7 +23,6 @@ import java.util.Collection;
|
||||
* they like and also dynamically remove or add items.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.1.0
|
||||
*
|
||||
*/
|
||||
public interface ItemRegistry {
|
||||
|
||||
@ -19,7 +19,6 @@ import java.util.Collection;
|
||||
* used in order to be notified of any dynamic changes in the provided items.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.4.0
|
||||
*
|
||||
*/
|
||||
public interface ItemRegistryChangeListener {
|
||||
|
||||
@ -19,7 +19,6 @@ import java.util.Collection;
|
||||
* the item registry are used in order to be notified of any dynamic changes in the provided items.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.1.0
|
||||
*
|
||||
*/
|
||||
public interface ItemsChangeListener {
|
||||
|
||||
@ -30,7 +30,6 @@ import org.openhab.core.types.UnDefType;
|
||||
* A ColorItem can be used for color values, e.g. for LED lights
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 1.2.0
|
||||
*
|
||||
*/
|
||||
public class ColorItem extends DimmerItem {
|
||||
|
||||
@ -28,7 +28,6 @@ import org.openhab.core.types.UnDefType;
|
||||
* This is useful for doors, windows, etc.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.1.0
|
||||
*
|
||||
*/
|
||||
public class ContactItem extends GenericItem {
|
||||
|
||||
@ -27,7 +27,6 @@ import org.openhab.core.types.UnDefType;
|
||||
* @author Thomas.Eichstaedt-Engelen
|
||||
* @author Kai Kreuzer
|
||||
*
|
||||
* @since 0.8.0
|
||||
*/
|
||||
public class DateTimeItem extends GenericItem {
|
||||
|
||||
|
||||
@ -30,7 +30,6 @@ import org.openhab.core.types.UnDefType;
|
||||
* to reflect the dimmed state.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.1.0
|
||||
*
|
||||
*/
|
||||
public class DimmerItem extends SwitchItem {
|
||||
|
||||
@ -27,7 +27,6 @@ import org.openhab.core.types.UnDefType;
|
||||
* This is useful for location awareness related functions
|
||||
*
|
||||
* @author Gaël L'hopital
|
||||
* @since 1.7.0
|
||||
*/
|
||||
public class LocationItem extends GenericItem {
|
||||
private static List<Class<? extends State>> acceptedDataTypes = new ArrayList<>();
|
||||
|
||||
@ -28,7 +28,6 @@ import org.openhab.core.types.UnDefType;
|
||||
* as a number.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.1.0
|
||||
*
|
||||
*/
|
||||
public class NumberItem extends GenericItem {
|
||||
|
||||
@ -28,7 +28,6 @@ import org.openhab.core.types.UnDefType;
|
||||
* from a device.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.1.0
|
||||
*
|
||||
*/
|
||||
public class StringItem extends GenericItem {
|
||||
|
||||
@ -28,7 +28,6 @@ import org.openhab.core.types.UnDefType;
|
||||
* Useful for normal lights, presence detection etc.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.1.0
|
||||
*
|
||||
*/
|
||||
public class SwitchItem extends GenericItem {
|
||||
|
||||
@ -26,7 +26,6 @@ import org.openhab.core.types.UnDefType;
|
||||
* for its calculations.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.7.0
|
||||
*
|
||||
*/
|
||||
public interface ArithmeticGroupFunction extends GroupFunction {
|
||||
@ -39,7 +38,6 @@ public interface ArithmeticGroupFunction extends GroupFunction {
|
||||
* items actually are not in the 'activeState'.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.7.0
|
||||
*
|
||||
*/
|
||||
static class And implements GroupFunction {
|
||||
@ -116,7 +114,6 @@ public interface ArithmeticGroupFunction extends GroupFunction {
|
||||
* items actually are in the 'activeState'.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.7.0
|
||||
*
|
||||
*/
|
||||
static class Or implements GroupFunction {
|
||||
@ -184,7 +181,6 @@ public interface ArithmeticGroupFunction extends GroupFunction {
|
||||
* passiveValue will be returned and vice versa.
|
||||
*
|
||||
* @author Thomas.Eichstaedt-Engelen
|
||||
* @since 1.0.0
|
||||
*/
|
||||
static class NAnd extends And {
|
||||
|
||||
@ -208,7 +204,6 @@ public interface ArithmeticGroupFunction extends GroupFunction {
|
||||
* passiveValue will be returned and vice versa.
|
||||
*
|
||||
* @author Thomas.Eichstaedt-Engelen
|
||||
* @since 1.0.0
|
||||
*/
|
||||
static class NOr extends Or {
|
||||
|
||||
@ -229,7 +224,6 @@ public interface ArithmeticGroupFunction extends GroupFunction {
|
||||
* This calculates the numeric average over all item states of decimal type.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.7.0
|
||||
*
|
||||
*/
|
||||
static class Avg implements GroupFunction {
|
||||
@ -278,7 +272,6 @@ public interface ArithmeticGroupFunction extends GroupFunction {
|
||||
* This calculates the numeric sum over all item states of decimal type.
|
||||
*
|
||||
* @author Thomas.Eichstaedt-Engelen
|
||||
* @since 1.1.0
|
||||
*
|
||||
*/
|
||||
static class Sum implements GroupFunction {
|
||||
@ -321,7 +314,6 @@ public interface ArithmeticGroupFunction extends GroupFunction {
|
||||
* This calculates the minimum value of all item states of decimal type.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.7.0
|
||||
*
|
||||
*/
|
||||
static class Min implements GroupFunction {
|
||||
@ -369,7 +361,6 @@ public interface ArithmeticGroupFunction extends GroupFunction {
|
||||
* This calculates the maximum value of all item states of decimal type.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.7.0
|
||||
*
|
||||
*/
|
||||
static class Max implements GroupFunction {
|
||||
|
||||
@ -27,7 +27,6 @@ import org.openhab.core.types.State;
|
||||
* brightness and can be used for color items.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 1.2.0
|
||||
*
|
||||
*/
|
||||
public class HSBType extends PercentType implements ComplexType, State, Command {
|
||||
|
||||
@ -18,7 +18,6 @@ import java.math.BigDecimal;
|
||||
* The PercentType extends the {@link DecimalType} by putting constraints for its value on top (0-100).
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.1.0
|
||||
*
|
||||
*/
|
||||
public class PercentType extends DecimalType {
|
||||
|
||||
@ -27,7 +27,6 @@ import org.openhab.core.types.State;
|
||||
* This type can be used for items that are dealing with GPS functionality.
|
||||
*
|
||||
* @author Gaël L'hopital
|
||||
* @since 1.7.0
|
||||
*/
|
||||
public class PointType implements ComplexType, Command, State {
|
||||
|
||||
|
||||
@ -35,7 +35,6 @@ import org.openhab.core.types.State;
|
||||
* easily chained in order to define a filter.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public class FilterCriteria {
|
||||
|
||||
|
||||
@ -27,7 +27,6 @@ import org.openhab.core.types.State;
|
||||
* </p>
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public interface HistoricItem {
|
||||
|
||||
|
||||
@ -21,7 +21,6 @@ import org.openhab.core.items.Item;
|
||||
* for sending data to an IoT (Internet of Things) service.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public interface PersistenceService {
|
||||
|
||||
|
||||
@ -17,7 +17,6 @@ package org.openhab.core.persistence;
|
||||
* data from openHAB. This is most likely some kind of database system.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public interface QueryablePersistenceService extends PersistenceService {
|
||||
|
||||
|
||||
@ -16,7 +16,6 @@ package org.openhab.core.scriptengine.action;
|
||||
* This interface must be implemented by services that want to contribute script actions.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 1.3.0
|
||||
*/
|
||||
public interface ActionService {
|
||||
|
||||
|
||||
@ -20,7 +20,6 @@ import org.slf4j.LoggerFactory;
|
||||
* background.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.7.0
|
||||
*/
|
||||
public abstract class AbstractActiveService {
|
||||
|
||||
|
||||
@ -17,7 +17,6 @@ package org.openhab.core.transform;
|
||||
* wrong. The originating exception should be attached to increase traceability.
|
||||
*
|
||||
* @author Thomas.Eichstaedt-Engelen
|
||||
* @since 0.7.0
|
||||
*/
|
||||
public class TransformationException extends Exception {
|
||||
|
||||
|
||||
@ -26,7 +26,6 @@ package org.openhab.core.transform;
|
||||
* @author Thomas.Eichstaedt-Engelen
|
||||
* œauthor Kai Kreuzer
|
||||
*
|
||||
* @since 0.7.0
|
||||
*/
|
||||
public interface TransformationService {
|
||||
|
||||
|
||||
@ -24,7 +24,6 @@ import org.slf4j.LoggerFactory;
|
||||
* transformations.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.8.0
|
||||
*
|
||||
*/
|
||||
public class Transformation {
|
||||
|
||||
@ -16,7 +16,6 @@ package org.openhab.core.types;
|
||||
* This is a marker interface for all command types.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.1.0
|
||||
*
|
||||
*/
|
||||
public interface Command extends Type {
|
||||
|
||||
@ -19,7 +19,6 @@ import java.util.SortedMap;
|
||||
* Each constituent can be referred to by a unique name.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.1.0
|
||||
*
|
||||
*/
|
||||
public interface ComplexType extends Type {
|
||||
|
||||
@ -20,7 +20,6 @@ package org.openhab.core.types;
|
||||
* type as an additional information on the event bus for each message.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.1.0
|
||||
*
|
||||
*/
|
||||
public enum EventType {
|
||||
|
||||
@ -16,7 +16,6 @@ package org.openhab.core.types;
|
||||
* A primitive type consists of a single value like a string, a number, etc.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.1.0
|
||||
*
|
||||
*/
|
||||
public interface PrimitiveType extends Type {
|
||||
|
||||
@ -16,7 +16,6 @@ package org.openhab.core.types;
|
||||
* This is a marker interface for all state types.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.1.0
|
||||
*
|
||||
*/
|
||||
public interface State extends Type {
|
||||
|
||||
@ -23,7 +23,6 @@ import java.util.Formatter;
|
||||
* to be both state and command at the same time.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.1.0
|
||||
*
|
||||
*/
|
||||
public interface Type {
|
||||
|
||||
@ -20,7 +20,6 @@ import java.util.List;
|
||||
* This is a helper class that helps parsing a string into an openHAB type (state or command).
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.1.0
|
||||
*
|
||||
*/
|
||||
public class TypeParser {
|
||||
|
||||
@ -20,7 +20,6 @@ package org.openhab.core.types;
|
||||
* an undefined state if it is dimmed to 50%).
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.1.0
|
||||
*
|
||||
*/
|
||||
public enum UnDefType implements PrimitiveType, State {
|
||||
|
||||
@ -18,7 +18,6 @@ package org.openhab.io.console;
|
||||
* It allows basic output commands.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.4.0
|
||||
*
|
||||
*/
|
||||
public interface Console {
|
||||
|
||||
@ -19,7 +19,6 @@ package org.openhab.io.console;
|
||||
* It must not be used productively!
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.4.0
|
||||
*
|
||||
*/
|
||||
public class ConsoleInterpreter {
|
||||
|
||||
@ -23,7 +23,6 @@ import org.openhab.io.net.exec.ExecUtil;
|
||||
* executing commands on command line.
|
||||
*
|
||||
* @author Pauli Anttila
|
||||
* @since 1.3.0
|
||||
*
|
||||
*/
|
||||
public class Exec {
|
||||
|
||||
@ -20,7 +20,6 @@ import org.openhab.io.net.http.HttpUtil;
|
||||
* for sending HTTP requests
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.9.0
|
||||
*
|
||||
*/
|
||||
public class HTTP {
|
||||
|
||||
@ -23,7 +23,6 @@ import java.net.SocketTimeoutException;
|
||||
* This Action checks the vitality of the given host.
|
||||
*
|
||||
* @author Thomas.Eichstaedt-Engelen
|
||||
* @since 1.0.0
|
||||
*/
|
||||
public class Ping {
|
||||
|
||||
|
||||
@ -47,7 +47,6 @@ import org.slf4j.LoggerFactory;
|
||||
*
|
||||
* @author Thomas.Eichstaedt-Engelen
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.6.0
|
||||
*/
|
||||
public class HttpUtil {
|
||||
|
||||
|
||||
@ -25,7 +25,6 @@ import org.osgi.service.http.HttpContext;
|
||||
* functionality to openHAB.
|
||||
*
|
||||
* @author Thomas.Eichstaedt-Engelen
|
||||
* @since 0.9.0
|
||||
*/
|
||||
public class SecureHttpContext implements HttpContext {
|
||||
|
||||
|
||||
@ -39,7 +39,6 @@ import org.slf4j.LoggerFactory;
|
||||
* <p>
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.6.0
|
||||
*
|
||||
*/
|
||||
public abstract class AbstractGenericBindingProvider implements BindingConfigReader, BindingProvider {
|
||||
|
||||
@ -19,7 +19,6 @@ import org.openhab.core.items.Item;
|
||||
* binding configuration string used in the {@link GenericItemProvider}.
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @since 0.3.0
|
||||
*
|
||||
*/
|
||||
public interface BindingConfigReader {
|
||||
|
||||
@ -23,7 +23,6 @@ import org.openhab.core.items.ItemNotFoundException;
|
||||
* chart servlet and returns a chart image object (PNG).
|
||||
*
|
||||
* @author Chris Jackson
|
||||
* @since 1.4.0
|
||||
*
|
||||
*
|
||||
*/
|
||||
|
||||
@ -26,7 +26,6 @@ import org.openhab.model.sitemap.Widget;
|
||||
*
|
||||
* @author Kai Kreuzer
|
||||
* @author Chris Jackson
|
||||
* @since 0.8.0
|
||||
*
|
||||
*/
|
||||
public interface ItemUIRegistry extends ItemRegistry, ItemUIProvider {
|
||||
|
||||
Loading…
Reference in New Issue
Block a user