* @param onOff new on/off state
* @param brightness new brightness
*/
- public void stateChangeNotify(int zoneId, boolean onOff, int brightness);
+ void stateChangeNotify(int zoneId, boolean onOff, int brightness);
/**
* Notify listener about hub connection change
*
* @param connected new connection state
*/
- public void connectionChangeNotify(boolean connected);
+ void connectionChangeNotify(boolean connected);
}
/**
* Returns the next collection dates per {@link WasteType}.
*/
- public Map<WasteType, CollectionDate> getCollectionDates() throws IOException;
+ Map<WasteType, CollectionDate> getCollectionDates() throws IOException;
}
/**
* Creates a new {@link AhaCollectionSchedule} for the given location.
*/
- public AhaCollectionSchedule create(final String commune, final String street, final String houseNumber,
+ AhaCollectionSchedule create(final String commune, final String street, final String houseNumber,
final String houseNumberAddon, final String collectionPlace);
}
*
* @param macAddress The mac address which sent the packet
*/
- public void packetCaptured(MacAddress sourceMacAddress);
+ void packetCaptured(MacAddress sourceMacAddress);
}
*
* @param newNetworkInterface The added networkInterface
*/
- public void onPcapNetworkInterfaceAdded(PcapNetworkInterfaceWrapper newNetworkInterface);
+ void onPcapNetworkInterfaceAdded(PcapNetworkInterfaceWrapper newNetworkInterface);
/**
* This method is called whenever a {@link PcapNetworkInterfaceWrapper} is removed.
*
* @param removedNetworkInterface The removed networkInterface
*/
- public void onPcapNetworkInterfaceRemoved(PcapNetworkInterfaceWrapper removedNetworkInterface);
+ void onPcapNetworkInterfaceRemoved(PcapNetworkInterfaceWrapper removedNetworkInterface);
}
@NonNullByDefault
public interface IWebSocketCommandHandler {
- public void webSocketCommandReceived(JsonPushCommand pushCommand);
+ void webSocketCommandReceived(JsonPushCommand pushCommand);
}
/*
* Set the channel group Id for the station
*/
- public void setChannelGroupId();
+ void setChannelGroupId();
/*
* Set the number of remote sensors supported by the station
*/
- public void setNumberOfSensors();
+ void setNumberOfSensors();
/*
* Updates the info channels (i.e. name and location) for a station
*/
- public void processInfoUpdate(AmbientWeatherStationHandler handler, String station, String name, String location);
+ void processInfoUpdate(AmbientWeatherStationHandler handler, String station, String name, String location);
/*
* Updates the weather data channels for a station
*/
- public void processWeatherData(AmbientWeatherStationHandler handler, String station, String jsonData);
+ void processWeatherData(AmbientWeatherStationHandler handler, String station, String jsonData);
}
*
* @param status The current status of the AmpliPi
*/
- public void receive(Status status);
+ void receive(Status status);
}
public interface Job extends SchedulerRunnable, Runnable {
/** Logger Instance */
- public final Logger LOGGER = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
+ final Logger LOGGER = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
/**
* Schedules the provided {@link Job} instance
* @param job the {@link Job} instance to schedule
* @param eventAt the {@link Calendar} instance denoting scheduled instant
*/
- public static void schedule(String thingUID, AstroThingHandler astroHandler, Job job, Calendar eventAt) {
+ static void schedule(String thingUID, AstroThingHandler astroHandler, Job job, Calendar eventAt) {
try {
Calendar today = Calendar.getInstance();
if (isSameDay(eventAt, today) && isTimeGreaterEquals(eventAt, today)) {
* @param event the event ID
* @param channelId the channel ID
*/
- public static void scheduleEvent(String thingUID, AstroThingHandler astroHandler, Calendar eventAt, String event,
+ static void scheduleEvent(String thingUID, AstroThingHandler astroHandler, Calendar eventAt, String event,
String channelId, boolean configAlreadyApplied) {
scheduleEvent(thingUID, astroHandler, eventAt, singletonList(event), channelId, configAlreadyApplied);
}
* @param events the event IDs to schedule
* @param channelId the channel ID
*/
- public static void scheduleEvent(String thingUID, AstroThingHandler astroHandler, Calendar eventAt,
- List<String> events, String channelId, boolean configAlreadyApplied) {
+ static void scheduleEvent(String thingUID, AstroThingHandler astroHandler, Calendar eventAt, List<String> events,
+ String channelId, boolean configAlreadyApplied) {
if (events.isEmpty()) {
return;
}
* @param range the {@link Range} instance
* @param channelId the channel ID
*/
- public static void scheduleRange(String thingUID, AstroThingHandler astroHandler, Range range, String channelId) {
+ static void scheduleRange(String thingUID, AstroThingHandler astroHandler, Range range, String channelId) {
final Channel channel = astroHandler.getThing().getChannel(channelId);
if (channel == null) {
LOGGER.warn("Cannot find channel '{}' for thing '{}'.", channelId, astroHandler.getThing().getUID());
scheduleEvent(thingUID, astroHandler, end, EVENT_END, channelId, true);
}
- public static Range adjustRangeToConfig(Range range, AstroChannelConfig config) {
+ static Range adjustRangeToConfig(Range range, AstroChannelConfig config) {
Calendar start = range.getStart();
Calendar end = range.getEnd();
* @param astroHandler the {@link AstroThingHandler} instance
* @param eventAt the {@link Calendar} instance denoting scheduled instant
*/
- public static void schedulePublishPlanet(String thingUID, AstroThingHandler astroHandler, Calendar eventAt) {
+ static void schedulePublishPlanet(String thingUID, AstroThingHandler astroHandler, Calendar eventAt) {
Job publishJob = new PublishPlanetJob(thingUID);
schedule(thingUID, astroHandler, publishJob, eventAt);
}
* @param sunPhaseName {@link SunPhaseName} instance
* @param eventAt the {@link Calendar} instance denoting scheduled instant
*/
- public static void scheduleSunPhase(String thingUID, AstroThingHandler astroHandler, SunPhaseName sunPhaseName,
+ static void scheduleSunPhase(String thingUID, AstroThingHandler astroHandler, SunPhaseName sunPhaseName,
Calendar eventAt) {
Job sunPhaseJob = new SunPhaseJob(thingUID, sunPhaseName);
schedule(thingUID, astroHandler, sunPhaseJob, eventAt);
/**
* Returns the thing UID that is associated with this {@link Job} (cannot be {@code null})
*/
- public String getThingUID();
+ String getThingUID();
}
*
* @param response a non-null, possibly empty response
*/
- public void responseReceived(String response);
+ void responseReceived(String response);
/**
* Called when a command finished with an exception or a general exception occurred while reading
*
* @param e a non-null exception
*/
- public void responseException(Exception e);
+ void responseException(Exception e);
}
*/
public interface BatteryModel {
- public static final BigDecimal BATTERY_OFF = BigDecimal.ZERO;
- public static final BigDecimal BATTERY_ON = BigDecimal.ONE;
+ static final BigDecimal BATTERY_OFF = BigDecimal.ZERO;
+ static final BigDecimal BATTERY_ON = BigDecimal.ONE;
BigDecimal getBattery();
*
* @return URI path as String
*/
- public String getPath();
+ String getPath();
/**
* Get the query String
*
* @return Query string as String
*/
- public String getArgs();
+ String getArgs();
}
*/
@NonNullByDefault
public interface BenqProjectorConnector {
- public static final int TIMEOUT_MS = 5 * 1000;
+ static final int TIMEOUT_MS = 5 * 1000;
- public static final String START = "\r*";
- public static final String END = "#\r";
- public static final String BLANK = "";
+ static final String START = "\r*";
+ static final String END = "#\r";
+ static final String BLANK = "";
/**
* Procedure for connecting to projector.
@NonNullByDefault
public interface ResponseListener {
- public void receivedResponse(GetBatteryLevelCommand command);
+ void receivedResponse(GetBatteryLevelCommand command);
- public void receivedResponse(GetAllCommand command);
+ void receivedResponse(GetAllCommand command);
- public void receivedResponse(GetLightLevelCommand command);
+ void receivedResponse(GetLightLevelCommand command);
- public void receivedResponse(GetPositionCommand command);
+ void receivedResponse(GetPositionCommand command);
- public void receivedResponse(GetSpeedCommand command);
+ void receivedResponse(GetSpeedCommand command);
}
@NonNullByDefault
public interface BlueZEventListener {
- public void onDBusBlueZEvent(BlueZEvent event);
+ void onDBusBlueZEvent(BlueZEvent event);
- public default void onDiscoveringChanged(AdapterDiscoveringChangedEvent event) {
+ default void onDiscoveringChanged(AdapterDiscoveringChangedEvent event) {
onDBusBlueZEvent(event);
}
- public default void onPoweredChange(AdapterPoweredChangedEvent event) {
+ default void onPoweredChange(AdapterPoweredChangedEvent event) {
onDBusBlueZEvent(event);
}
- public default void onRssiUpdate(RssiEvent event) {
+ default void onRssiUpdate(RssiEvent event) {
onDBusBlueZEvent(event);
}
- public default void onTxPowerUpdate(TXPowerEvent event) {
+ default void onTxPowerUpdate(TXPowerEvent event) {
onDBusBlueZEvent(event);
}
- public default void onCharacteristicNotify(CharacteristicUpdateEvent event) {
+ default void onCharacteristicNotify(CharacteristicUpdateEvent event) {
onDBusBlueZEvent(event);
}
- public default void onManufacturerDataUpdate(ManufacturerDataEvent event) {
+ default void onManufacturerDataUpdate(ManufacturerDataEvent event) {
onDBusBlueZEvent(event);
}
- public default void onServiceDataUpdate(ServiceDataEvent event) {
+ default void onServiceDataUpdate(ServiceDataEvent event) {
onDBusBlueZEvent(event);
}
- public default void onConnectedStatusUpdate(ConnectedEvent event) {
+ default void onConnectedStatusUpdate(ConnectedEvent event) {
onDBusBlueZEvent(event);
}
- public default void onNameUpdate(NameEvent event) {
+ default void onNameUpdate(NameEvent event) {
onDBusBlueZEvent(event);
}
- public default void onServicesResolved(ServicesResolvedEvent event) {
+ default void onServicesResolved(ServicesResolvedEvent event) {
onDBusBlueZEvent(event);
}
}
@NonNullByDefault
public interface ResponseListener {
- public void receivedResponse(byte[] bytes);
+ void receivedResponse(byte[] bytes);
- public void receivedResponse(GetVersionCommand command);
+ void receivedResponse(GetVersionCommand command);
- public void receivedResponse(GetFanspeedCommand command);
+ void receivedResponse(GetFanspeedCommand command);
- public void receivedResponse(GetOperationmodeCommand command);
+ void receivedResponse(GetOperationmodeCommand command);
- public void receivedResponse(GetPowerstateCommand command);
+ void receivedResponse(GetPowerstateCommand command);
- public void receivedResponse(GetSetpointCommand command);
+ void receivedResponse(GetSetpointCommand command);
- public void receivedResponse(GetIndoorOutoorTemperatures command);
+ void receivedResponse(GetIndoorOutoorTemperatures command);
- public void receivedResponse(SetPowerstateCommand command);
+ void receivedResponse(SetPowerstateCommand command);
- public void receivedResponse(SetSetpointCommand command);
+ void receivedResponse(SetSetpointCommand command);
- public void receivedResponse(SetOperationmodeCommand command);
+ void receivedResponse(SetOperationmodeCommand command);
- public void receivedResponse(SetFanspeedCommand command);
+ void receivedResponse(SetFanspeedCommand command);
- public void receivedResponse(GetOperationHoursCommand command);
+ void receivedResponse(GetOperationHoursCommand command);
- public void receivedResponse(GetEyeBrightnessCommand command);
+ void receivedResponse(GetEyeBrightnessCommand command);
- public void receivedResponse(SetEyeBrightnessCommand command);
+ void receivedResponse(SetEyeBrightnessCommand command);
- public void receivedResponse(GetCleanFilterIndicatorCommand command);
+ void receivedResponse(GetCleanFilterIndicatorCommand command);
}
@NonNullByDefault
public interface GattMessage {
- public byte[] getPayload();
+ byte[] getPayload();
}
* @param payload
* @return true if this handler should be removed from the handler list
*/
- public boolean handleReceivedMessage(R message);
+ boolean handleReceivedMessage(R message);
/**
*
* @param payload
* @return true if this handler should be removed from the handler list
*/
- public boolean handleFailedMessage(T message, Throwable th);
+ boolean handleFailedMessage(T message, Throwable th);
}
public interface MessageServicer<T extends GattMessage, R extends GattMessage>
extends MessageHandler<T, R>, MessageSupplier<T> {
- public long getTimeout(TimeUnit unit);
+ long getTimeout(TimeUnit unit);
}
@NonNullByDefault
public interface MessageSupplier<M extends GattMessage> {
- public M createMessage();
+ M createMessage();
}
*
* @return a set of thing type UIDs for which results can be created
*/
- public Set<ThingTypeUID> getSupportedThingTypeUIDs();
+ Set<ThingTypeUID> getSupportedThingTypeUIDs();
/**
* Creates a discovery result for a Bluetooth device
* @return the according discovery result or <code>null</code>, if device is not
* supported by this participant
*/
- public @Nullable DiscoveryResult createResult(BluetoothDiscoveryDevice device);
+ @Nullable
+ DiscoveryResult createResult(BluetoothDiscoveryDevice device);
/**
* Returns the thing UID for a Bluetooth device
* @param device the Bluetooth device
* @return a thing UID or <code>null</code>, if the device is not supported by this participant
*/
- public @Nullable ThingUID getThingUID(BluetoothDiscoveryDevice device);
+ @Nullable
+ ThingUID getThingUID(BluetoothDiscoveryDevice device);
/**
* Returns true if this participant requires the device to be connected before it can produce a
* @param device the Bluetooth device
* @return true if a connection is required before calling {@link createResult(BluetoothDevice)}
*/
- public default boolean requiresConnection(BluetoothDiscoveryDevice device) {
+ default boolean requiresConnection(BluetoothDiscoveryDevice device) {
return false;
}
* @param result the DiscoveryResult to post-process
* @param publisher the consumer to publish additional results to.
*/
- public default void publishAdditionalResults(DiscoveryResult result,
+ default void publishAdditionalResults(DiscoveryResult result,
BiConsumer<BluetoothAdapter, DiscoveryResult> publisher) {
// do nothing by default
}
*
* @return the order of this participant, default 0
*/
- public default int order() {
+ default int order() {
return 0;
}
}
@NonNullByDefault
public interface AvailableSources {
- public boolean isBluetoothAvailable();
+ boolean isBluetoothAvailable();
- public boolean isAUXAvailable();
+ boolean isAUXAvailable();
- public boolean isAUX1Available();
+ boolean isAUX1Available();
- public boolean isAUX2Available();
+ boolean isAUX2Available();
- public boolean isAUX3Available();
+ boolean isAUX3Available();
- public boolean isTVAvailable();
+ boolean isTVAvailable();
- public boolean isHDMI1Available();
+ boolean isHDMI1Available();
- public boolean isInternetRadioAvailable();
+ boolean isInternetRadioAvailable();
- public boolean isStoredMusicAvailable();
+ boolean isStoredMusicAvailable();
- public boolean isBassAvailable();
+ boolean isBassAvailable();
- public void setAUXAvailable(boolean aux);
+ void setAUXAvailable(boolean aux);
- public void setAUX1Available(boolean aux1);
+ void setAUX1Available(boolean aux1);
- public void setAUX2Available(boolean aux2);
+ void setAUX2Available(boolean aux2);
- public void setAUX3Available(boolean aux3);
+ void setAUX3Available(boolean aux3);
- public void setStoredMusicAvailable(boolean storedMusic);
+ void setStoredMusicAvailable(boolean storedMusic);
- public void setInternetRadioAvailable(boolean internetRadio);
+ void setInternetRadioAvailable(boolean internetRadio);
- public void setBluetoothAvailable(boolean bluetooth);
+ void setBluetoothAvailable(boolean bluetooth);
- public void setTVAvailable(boolean tv);
+ void setTVAvailable(boolean tv);
- public void setHDMI1Available(boolean hdmi1);
+ void setHDMI1Available(boolean hdmi1);
- public void setBassAvailable(boolean bass);
+ void setBassAvailable(boolean bass);
}
*/
@NonNullByDefault
public interface CaddxPanelListener {
- public void caddxMessage(CaddxMessage message);
+ void caddxMessage(CaddxMessage message);
}
* Returns the value for this attribute.
*/
@Nullable
- public abstract Object getValue(TimetableStop stop);
+ Object getValue(TimetableStop stop);
/**
* Returns the {@link State} that should be set for the channels'value for this attribute.
*/
@Nullable
- public abstract State getState(TimetableStop stop);
+ State getState(TimetableStop stop);
/**
* Returns a list of values as string list.
* Returns empty list if value is not present, singleton list if attribute is not single-valued.
*/
- public abstract List<String> getStringValues(TimetableStop t);
+ List<String> getStringValues(TimetableStop t);
}
/**
* Handles {@link ChannelNameEquals}.
*/
- public abstract R handle(ChannelNameEquals equals) throws FilterParserException;
+ R handle(ChannelNameEquals equals) throws FilterParserException;
/**
* Handles {@link OrOperator}.
*/
- public abstract R handle(OrOperator operator) throws FilterParserException;
+ R handle(OrOperator operator) throws FilterParserException;
/**
* Handles {@link AndOperator}.
*/
- public abstract R handle(AndOperator operator) throws FilterParserException;
+ R handle(AndOperator operator) throws FilterParserException;
/**
* Handles {@link BracketOpenToken}.
*/
- public abstract R handle(BracketOpenToken token) throws FilterParserException;
+ R handle(BracketOpenToken token) throws FilterParserException;
/**
* Handles {@link BracketCloseToken}.
*/
- public abstract R handle(BracketCloseToken token) throws FilterParserException;
+ R handle(BracketCloseToken token) throws FilterParserException;
}
*
* @return The {@link Timetable} containing the planned arrivals and departues.
*/
- public abstract Timetable getPlan(String evaNo, Date time) throws IOException;
+ Timetable getPlan(String evaNo, Date time) throws IOException;
/**
* Requests all known changes in the timetable for the given station.
*
* @return The {@link Timetable} containing all known changes for the given station.
*/
- public abstract Timetable getFullChanges(String evaNo) throws IOException;
+ Timetable getFullChanges(String evaNo) throws IOException;
/**
* Requests the timetable with the planned data for the given station and time.
*
* @return The {@link Timetable} containing recent changes (from last two minutes) for the given station.
*/
- public abstract Timetable getRecentChanges(String evaNo) throws IOException;
+ Timetable getRecentChanges(String evaNo) throws IOException;
}
/**
* Creates a new instance of the {@link TimetablesV1Api}.
*/
- public abstract TimetablesV1Api create(final String clientId, final String clientSecret,
- final HttpCallable httpCallable) throws JAXBException;
+ TimetablesV1Api create(final String clientId, final String clientSecret, final HttpCallable httpCallable)
+ throws JAXBException;
}
@NonNullByDefault
public interface TimetablesV1ImplTestHelper {
- public static final String EVA_LEHRTE = "8000226";
- public static final String EVA_HANNOVER_HBF = "8000152";
- public static final String CLIENT_ID = "bdwrpmxuo6157jrekftlbcc6ju9awo";
- public static final String CLIENT_SECRET = "354c8161cd7fb0936c840240280c131e";
+ static final String EVA_LEHRTE = "8000226";
+ static final String EVA_HANNOVER_HBF = "8000152";
+ static final String CLIENT_ID = "bdwrpmxuo6157jrekftlbcc6ju9awo";
+ static final String CLIENT_SECRET = "354c8161cd7fb0936c840240280c131e";
/**
* Creates a {@link TimetablesApiTestModule} that uses http response data from file system.
* Uses default-testdata from directory /timetablesData
*/
- public default TimetablesApiTestModule createApiWithTestdata() throws Exception {
+ default TimetablesApiTestModule createApiWithTestdata() throws Exception {
return this.createApiWithTestdata("/timetablesData");
}
*
* @param dataDirectory Directory within test-resources containing the stub-data.
*/
- public default TimetablesApiTestModule createApiWithTestdata(String dataDirectory) throws Exception {
+ default TimetablesApiTestModule createApiWithTestdata(String dataDirectory) throws Exception {
final URL timetablesData = getClass().getResource(dataDirectory);
assertNotNull(timetablesData);
final File testDataDir = new File(timetablesData.toURI());
*/
public interface ConnectionManager {
- public static final int GENERAL_EXCEPTION = -1;
- public static final int MALFORMED_URL_EXCEPTION = -2;
- public static final int CONNECTION_EXCEPTION = -3;
- public static final int SOCKET_TIMEOUT_EXCEPTION = -4;
- public static final int UNKNOWN_HOST_EXCEPTION = -5;
- public static final int AUTHENTIFICATION_PROBLEM = -6;
- public static final int SSL_HANDSHAKE_EXCEPTION = -7;
+ static final int GENERAL_EXCEPTION = -1;
+ static final int MALFORMED_URL_EXCEPTION = -2;
+ static final int CONNECTION_EXCEPTION = -3;
+ static final int SOCKET_TIMEOUT_EXCEPTION = -4;
+ static final int UNKNOWN_HOST_EXCEPTION = -5;
+ static final int AUTHENTIFICATION_PROBLEM = -6;
+ static final int SSL_HANDSHAKE_EXCEPTION = -7;
/**
* Returns the {@link HttpTransport} to execute queries or special commands on the digitalSTROM-Server.
*
* @param resultProcessor
*/
- public void registerResultProcessor(JsonResultProcessor resultProcessor);
+ void registerResultProcessor(JsonResultProcessor resultProcessor);
}
*/
@NonNullByDefault
public interface EcovacsApi {
- public static EcovacsApi create(HttpClient httpClient, EcovacsApiConfiguration configuration) {
+ static EcovacsApi create(HttpClient httpClient, EcovacsApiConfiguration configuration) {
return new EcovacsApiImpl(httpClient, configuration);
}
- public void loginAndGetAccessToken() throws EcovacsApiException, InterruptedException;
+ void loginAndGetAccessToken() throws EcovacsApiException, InterruptedException;
- public List<EcovacsDevice> getDevices() throws EcovacsApiException, InterruptedException;
+ List<EcovacsDevice> getDevices() throws EcovacsApiException, InterruptedException;
}
*/
@NonNullByDefault
public interface EcovacsDevice {
- public interface EventListener {
+ interface EventListener {
void onFirmwareVersionChanged(EcovacsDevice device, String fwVersion);
void onBatteryLevelUpdated(EcovacsDevice device, int newLevelPercent);
*/
@NonNullByDefault
public interface EventListener {
- public void eventReceived(EventMessage event);
+ void eventReceived(EventMessage event);
}
@NonNullByDefault
public interface PacketListener {
- public void packetReceived(BasePacket packet);
+ void packetReceived(BasePacket packet);
- public long getEnOceanIdToListenTo();
+ long getEnOceanIdToListenTo();
}
@NonNullByDefault
public interface TransceiverErrorListener {
- public void errorOccured(Throwable exception);
+ void errorOccured(Throwable exception);
}
@NonNullByDefault
public interface RunnableWithTimeout {
- public abstract void run() throws TimeoutException;
+ void run() throws TimeoutException;
}
*/
public interface RequestBuilder<T> {
- public T build();
+ T build();
}
*
* @param status The new status of the account thing
*/
- public void accountStatusChanged(ThingStatus status);
+ void accountStatusChanged(ThingStatus status);
}
* @param bdaddr Bluetooth address of the discovered Flic button
* @return UID that was created by the discovery service
*/
- public ThingUID flicButtonDiscovered(Bdaddr bdaddr);
+ ThingUID flicButtonDiscovered(Bdaddr bdaddr);
- public void activate(FlicClient client);
+ void activate(FlicClient client);
- public void deactivate();
+ void deactivate();
}
* @param lanHosts the LAN data received from the Freebox server.
* @param airPlayDevices the list of AirPlay devices received from the Freebox server.
*/
- public void onDataFetched(ThingUID bridge, @Nullable List<FreeboxLanHost> lanHosts,
+ void onDataFetched(ThingUID bridge, @Nullable List<FreeboxLanHost> lanHosts,
@Nullable List<FreeboxAirMediaReceiver> airPlayDevices);
}
/**
* Disposes Gardena smart system.
*/
- public void dispose();
+ void dispose();
/**
* Returns all devices from all locations.
*/
- public Collection<Device> getAllDevices();
+ Collection<Device> getAllDevices();
/**
* Returns a device with the given id.
*/
- public Device getDevice(String deviceId) throws GardenaDeviceNotFoundException;
+ Device getDevice(String deviceId) throws GardenaDeviceNotFoundException;
/**
* Sends a command to Gardena smart system.
*/
- public void sendCommand(DataItem<?> dataItem, GardenaCommand gardenaCommand) throws GardenaException;
+ void sendCommand(DataItem<?> dataItem, GardenaCommand gardenaCommand) throws GardenaException;
/**
* Returns the id.
*/
- public String getId();
+ String getId();
/**
* Restarts all WebSocket.
*/
- public void restartWebsockets();
+ void restartWebsockets();
}
/**
* Called when a device has been updated.
*/
- public void onDeviceUpdated(Device device);
+ void onDeviceUpdated(Device device);
/**
* Called when a new device has been detected.
*/
- public void onNewDevice(Device device);
+ void onNewDevice(Device device);
/**
* Called when an unrecoverable error occurs.
*/
- public void onError();
+ void onError();
}
*
* @return module number as String
*/
- public String getModule();
+ String getModule();
/**
* Get the connector number to which the command will be sent
*
* @return connector number as String
*/
- public String getConnector();
+ String getConnector();
/**
* Used by command implementations to parse the device's response
*/
- abstract void parseSuccessfulReply();
+ void parseSuccessfulReply();
/*
* Used by command implementations to report a successful command execution
*/
- abstract void logSuccess();
+ void logSuccess();
/*
* Used by command implementations to report a failed command execution
*/
- abstract void logFailure();
+ void logFailure();
}
*/
@NonNullByDefault
public interface HubStatusListener {
- public void hubStatusChanged(ThingStatus status);
+ void hubStatusChanged(ThingStatus status);
}
/**
* Initializes the Homematic gateway and starts the watchdog thread.
*/
- public void initialize() throws IOException;
+ void initialize() throws IOException;
/**
* Disposes the HomematicGateway and stops everything.
*/
- public void dispose();
+ void dispose();
/**
* Returns the cached datapoint.
*/
- public HmDatapoint getDatapoint(HmDatapointInfo dpInfo) throws HomematicClientException;
+ HmDatapoint getDatapoint(HmDatapointInfo dpInfo) throws HomematicClientException;
/**
* Returns the cached device.
*/
- public HmDevice getDevice(String address) throws HomematicClientException;
+ HmDevice getDevice(String address) throws HomematicClientException;
/**
* Cancel loading all device metadata.
*/
- public void cancelLoadAllDeviceMetadata();
+ void cancelLoadAllDeviceMetadata();
/**
* Loads all device, channel and datapoint metadata from the gateway.
*/
- public void loadAllDeviceMetadata() throws IOException;
+ void loadAllDeviceMetadata() throws IOException;
/**
* Loads all values into the given channel.
*/
- public void loadChannelValues(HmChannel channel) throws IOException;
+ void loadChannelValues(HmChannel channel) throws IOException;
/**
* Loads the value of the given {@link HmDatapoint} from the device.
*
* @param dp The HmDatapoint that shall be loaded
*/
- public void loadDatapointValue(HmDatapoint dp) throws IOException;
+ void loadDatapointValue(HmDatapoint dp) throws IOException;
/**
* Reenumerates the set of VALUES datapoints for the given channel.
*/
- public void updateChannelValueDatapoints(HmChannel channel) throws IOException;
+ void updateChannelValueDatapoints(HmChannel channel) throws IOException;
/**
* Prepares the device for reloading all values from the gateway.
*/
- public void triggerDeviceValuesReload(HmDevice device);
+ void triggerDeviceValuesReload(HmDevice device);
/**
* Sends the datapoint to the Homematic gateway or executes virtual datapoints.
* {@link HomematicBindingConstants#RX_WAKEUP_MODE "WAKEUP"} for wakeup mode, or null for the default
* mode)
*/
- public void sendDatapoint(HmDatapoint dp, HmDatapointConfig dpConfig, Object newValue, String rxMode)
+ void sendDatapoint(HmDatapoint dp, HmDatapointConfig dpConfig, Object newValue, String rxMode)
throws IOException, HomematicClientException;
/**
* Returns the id of the HomematicGateway.
*/
- public String getId();
+ String getId();
/**
* Set install mode of homematic controller. During install mode the
* @param seconds specify how long the install mode should last
* @throws IOException if RpcClient fails to propagate command
*/
- public void setInstallMode(boolean enable, int seconds) throws IOException;
+ void setInstallMode(boolean enable, int seconds) throws IOException;
/**
* Get current install mode of homematic contoller
* <i>install_mode==false</i>
* @throws IOException if RpcClient fails to propagate command
*/
- public int getInstallMode() throws IOException;
+ int getInstallMode() throws IOException;
/**
* Loads all rssi values from the gateway.
*/
- public void loadRssiValues() throws IOException;
+ void loadRssiValues() throws IOException;
/**
* Starts the connection and event tracker threads.
*/
- public void startWatchdogs();
+ void startWatchdogs();
/**
* Deletes the device from the gateway.
* @param force <i>true</i> will delete the device even if it is not reachable.
* @param defer <i>true</i> will delete the device once it becomes available.
*/
- public void deleteDevice(String address, boolean reset, boolean force, boolean defer);
+ void deleteDevice(String address, boolean reset, boolean force, boolean defer);
}
/**
* Called when a datapoint has been updated.
*/
- public void onStateUpdated(HmDatapoint dp);
+ void onStateUpdated(HmDatapoint dp);
/**
* Called when a new device has been detected on the gateway.
*/
- public void onNewDevice(HmDevice device);
+ void onNewDevice(HmDevice device);
/**
* Called when a device has been deleted from the gateway.
*/
- public void onDeviceDeleted(HmDevice device);
+ void onDeviceDeleted(HmDevice device);
/**
* Called when the devices values should be reloaded from the gateway.
*/
- public void reloadDeviceValues(HmDevice device);
+ void reloadDeviceValues(HmDevice device);
/**
* Called when all values for all devices should be reloaded from the gateway.
*/
- public void reloadAllDeviceValues();
+ void reloadAllDeviceValues();
/**
* Called when a device has been loaded from the gateway.
*/
- public void onDeviceLoaded(HmDevice device);
+ void onDeviceLoaded(HmDevice device);
/**
* Called when the connection is lost to the gateway.
*/
- public void onConnectionLost();
+ void onConnectionLost();
/**
* Called when the connection is resumed to the gateway.
*/
- public void onConnectionResumed();
+ void onConnectionResumed();
/**
* Returns the configuration of a datapoint.
*/
- public HmDatapointConfig getDatapointConfig(HmDatapoint dp);
+ HmDatapointConfig getDatapointConfig(HmDatapoint dp);
/**
* Called when a new value for the duty cycle of the gateway has been received.
*/
- public void onDutyCycleRatioUpdate(int dutyCycleRatio);
+ void onDutyCycleRatioUpdate(int dutyCycleRatio);
}
/**
* Adds arguments to the RPC method.
*/
- public void addArg(Object arg);
+ void addArg(Object arg);
/**
* Generates the RPC data.
*/
- public T createMessage();
+ T createMessage();
/**
* Returns the name of the rpc method.
*/
- public String getMethodName();
+ String getMethodName();
}
/**
* Returns the decoded methodName.
*/
- public String getMethodName();
+ String getMethodName();
/**
* Returns the decoded data.
*/
- public Object[] getResponseData();
+ Object[] getResponseData();
}
/**
* Parses the message returns the result.
*/
- public R parse(M message) throws IOException;
+ R parse(M message) throws IOException;
}
/**
* Called when a new event is received from a Homeamtic gateway.
*/
- public void eventReceived(HmDatapointInfo dpInfo, Object newValue);
+ void eventReceived(HmDatapointInfo dpInfo, Object newValue);
/**
* Called when new devices has been detected on the Homeamtic gateway.
*/
- public void newDevices(List<String> adresses);
+ void newDevices(List<String> adresses);
/**
* Called when devices has been deleted from the Homeamtic gateway.
*/
- public void deleteDevices(List<String> addresses);
+ void deleteDevices(List<String> addresses);
}
/**
* Starts the rpc server.
*/
- public void start() throws IOException;
+ void start() throws IOException;
/**
* Stops the rpc server.
*/
- public void shutdown();
+ void shutdown();
}
/**
* Returns the virtual datapoint name.
*/
- public String getName();
+ String getName();
/**
* Adds the virtual datapoint to the device.
*/
- public void initialize(HmDevice device);
+ void initialize(HmDevice device);
/**
* Returns true, if the virtual datapoint can handle a command for the given datapoint.
*/
- public boolean canHandleCommand(HmDatapoint dp, Object value);
+ boolean canHandleCommand(HmDatapoint dp, Object value);
/**
* Handles the special functionality for the given virtual datapoint.
*/
- public void handleCommand(VirtualGateway gateway, HmDatapoint dp, HmDatapointConfig dpConfig, Object value)
+ void handleCommand(VirtualGateway gateway, HmDatapoint dp, HmDatapointConfig dpConfig, Object value)
throws IOException, HomematicClientException;
/**
* Returns true, if the virtual datapoint can handle the event for the given datapoint.
*/
- public boolean canHandleEvent(HmDatapoint dp);
+ boolean canHandleEvent(HmDatapoint dp);
/**
* Handles an event to extract data required for the virtual datapoint.
*/
- public void handleEvent(VirtualGateway gateway, HmDatapoint dp);
+ void handleEvent(VirtualGateway gateway, HmDatapoint dp);
/**
* Returns the virtual datapoint in the given channel.
*/
- public HmDatapoint getVirtualDatapoint(HmChannel channel);
+ HmDatapoint getVirtualDatapoint(HmChannel channel);
}
/**
* Sends the datapoint from a virtual datapoint.
*/
- public void sendDatapointIgnoreVirtual(HmDatapoint dp, HmDatapointConfig dpConfig, Object newValue)
+ void sendDatapointIgnoreVirtual(HmDatapoint dp, HmDatapointConfig dpConfig, Object newValue)
throws IOException, HomematicClientException;
/**
* Returns the rpc client.
*/
- public RpcClient<?> getRpcClient(HmInterface hmInterface) throws IOException;
+ RpcClient<?> getRpcClient(HmInterface hmInterface) throws IOException;
/**
* Disables a boolean datapoint by setting the value to false after a given delay.
*/
- public void disableDatapoint(HmDatapoint dp, double delay);
+ void disableDatapoint(HmDatapoint dp, double delay);
/**
* Returns the event listener.
*/
- public HomematicGatewayAdapter getGatewayAdapter();
+ HomematicGatewayAdapter getGatewayAdapter();
}
/**
* Converts an openHAB type to a Homematic value.
*/
- public Object convertToBinding(Type type, HmDatapoint dp) throws ConverterException;
+ Object convertToBinding(Type type, HmDatapoint dp) throws ConverterException;
/**
* Converts a Homematic value to an openHAB type.
*/
- public T convertFromBinding(HmDatapoint dp) throws ConverterException;
+ T convertFromBinding(HmDatapoint dp) throws ConverterException;
}
/**
* Adds the ChannelGroupType to this provider.
*/
- public void addChannelGroupType(ChannelGroupType channelGroupType);
+ void addChannelGroupType(ChannelGroupType channelGroupType);
/**
* Use this method to lookup a ChannelGroupType which was generated by the
* <i>null</i> if no ChannelGroupType with the given UID was added
* before
*/
- public ChannelGroupType getInternalChannelGroupType(ChannelGroupTypeUID channelGroupTypeUID);
+ ChannelGroupType getInternalChannelGroupType(ChannelGroupTypeUID channelGroupTypeUID);
}
/**
* Adds the ChannelType to this provider.
*/
- public void addChannelType(ChannelType channelType);
+ void addChannelType(ChannelType channelType);
/**
* Use this method to lookup a ChannelType which was generated by the
* <i>null</i> if no ChannelType with the given UID was added
* before
*/
- public ChannelType getInternalChannelType(ChannelTypeUID channelTypeUID);
+ ChannelType getInternalChannelType(ChannelTypeUID channelTypeUID);
}
/**
* Adds the ConfigDescription to this provider.
*/
- public void addConfigDescription(ConfigDescription configDescription);
+ void addConfigDescription(ConfigDescription configDescription);
/**
* Provides a {@link ConfigDescription} for the given URI.
* <i>null</i> if no ConfigDescription with the given URI was added
* before
*/
- public ConfigDescription getInternalConfigDescription(URI uri);
+ ConfigDescription getInternalConfigDescription(URI uri);
}
/**
* Adds the ThingType to this provider.
*/
- public void addThingType(ThingType thingType);
+ void addThingType(ThingType thingType);
/**
* Use this method to lookup a ThingType which was generated by the
* <i>null</i> if no ThingType with the given thingTypeUID was added
* before
*/
- public ThingType getInternalThingType(ThingTypeUID thingTypeUID);
+ ThingType getInternalThingType(ThingTypeUID thingTypeUID);
}
/**
* Initializes the type generator.
*/
- public void initialize();
+ void initialize();
/**
* Generates the ThingType and ChannelTypes for the given device.
*/
- public void generate(HmDevice device);
+ void generate(HmDevice device);
/**
* Validates all devices for multiple firmware versions. Different firmware versions for the same device may have
* different datapoints which may cause warnings in the logfile.
*/
- public void validateFirmwares();
+ void validateFirmwares();
}
* @return {@link ThingTypeUID}s of ThingTypes that are supposed to be
* excluded from the binding's thing-type generation
*/
- public Set<ThingTypeUID> getExcludedThingTypes();
+ Set<ThingTypeUID> getExcludedThingTypes();
/**
* Check for the given {@link ThingTypeUID} whether it is excluded by this
* @param thingType a specific ThingType, specified by its {@link ThingTypeUID}
* @return <i>true</i>, if the {@link ThingType} is excluded
*/
- public boolean isThingTypeExcluded(ThingTypeUID thingType);
+ boolean isThingTypeExcluded(ThingTypeUID thingType);
/**
* Check for the given {@link ChannelTypeUID} whether it is excluded by this
* @return <i>true</i>, if the {@link org.openhab.core.thing.type.ChannelType} is
* excluded
*/
- public boolean isChannelTypeExcluded(ChannelTypeUID channelType);
+ boolean isChannelTypeExcluded(ChannelTypeUID channelType);
/**
* Check for the given {@link ChannelGroupTypeUID} whether it is excluded by
* {@link org.openhab.core.thing.type.ChannelGroupType} is
* excluded
*/
- public boolean isChannelGroupTypeExcluded(ChannelGroupTypeUID channelGroupType);
+ boolean isChannelGroupTypeExcluded(ChannelGroupTypeUID channelGroupType);
/**
* Check for the given config-description-{@link URI} whether it is excluded by
* @return <i>true</i>, if the {@link org.openhab.core.config.core.ConfigDescription} is
* excluded
*/
- public boolean isConfigDescriptionExcluded(URI configDescriptionURI);
+ boolean isConfigDescriptionExcluded(URI configDescriptionURI);
}
*/
@NonNullByDefault
public interface HydrawiseControllerListener {
- public void onData(List<Controller> controllers);
+ void onData(List<Controller> controllers);
}
/**
* Notification that querying of the modems on all ports has successfully completed.
*/
- public abstract void driverCompletelyInitialized();
+ void driverCompletelyInitialized();
/**
* Notification that the driver was disconnected
*/
- public abstract void disconnected();
+ void disconnected();
}
*
* @param msg the message received
*/
- public abstract void msg(Msg msg);
+ void msg(Msg msg);
}
* @param bridge
* @param command the infrared command
*/
- public void onCommandReceived(EthernetBridgeHandler bridge, IrCommand command);
+ void onCommandReceived(EthernetBridgeHandler bridge, IrCommand command);
}
* @author Volker Bier - Initial contribution
*/
public interface JeeLinkReadingConverter<R extends Reading> {
- public R createReading(String inputLine);
+ R createReading(String inputLine);
}
* @author Volker Bier - Initial contribution
*/
public interface ReadingHandler<R extends Reading> {
- public void handleReading(R r);
+ void handleReading(R r);
- public Class<R> getReadingClass();
+ Class<R> getReadingClass();
- public String getSensorType();
+ String getSensorType();
}
* @author Volker Bier - Initial contribution
*/
public interface ReadingPublisher<R extends Reading> {
- public void publish(R reading);
+ void publish(R reading);
- public void dispose();
+ void dispose();
}
/**
* Called whenever input has been read from the connection.
*/
- public void handleInput(String input);
+ void handleInput(String input);
}
*/
@NonNullByDefault
public interface KM200GatewayStatusListener {
- public void gatewayStatusChanged(ThingStatus status);
+ void gatewayStatusChanged(ThingStatus status);
}
final int propertyId, final int start, final int elements, boolean authenticate, long timeout)
throws InterruptedException;
- public boolean isConnected();
+ boolean isConnected();
}
*
* @param destination
*/
- public boolean listensTo(GroupAddress destination);
+ boolean listensTo(GroupAddress destination);
}
* @author Christoph Weitkamp - Improvements for playing audio notifications
*/
public interface KodiEventListener extends EventListener {
- public enum KodiState {
+ enum KodiState {
PLAY,
PAUSE,
END,
FASTFORWARD
}
- public enum KodiPlaylistState {
+ enum KodiPlaylistState {
ADD,
ADDED,
INSERT,
*
* @return the version
*/
- public String getVersion();
+ String getVersion();
/**
* Send a low priority message to the device.
* @throws NotificationCreationException
* if there is a communication error or malformed data
*/
- public String notifyInfo(String message) throws NotificationCreationException;
+ String notifyInfo(String message) throws NotificationCreationException;
/**
* Send a medium priority message to the device.
* @throws NotificationCreationException
* if there is a communication error or malformed data
*/
- public String notifyWarning(String message) throws NotificationCreationException;
+ String notifyWarning(String message) throws NotificationCreationException;
/**
* Send an urgent message to the device. The notification will not be
* @throws NotificationCreationException
* if there is a communication error or malformed data
*/
- public String notifyCritical(String message) throws NotificationCreationException;
+ String notifyCritical(String message) throws NotificationCreationException;
/**
* Send a notification to the device.
* @throws NotificationCreationException
* if there is a communication error or malformed data
*/
- public String notify(String message, Priority priority, Icon icon, Sound sound, int messageRepeat, int soundRepeat)
+ String notify(String message, Priority priority, Icon icon, Sound sound, int messageRepeat, int soundRepeat)
throws NotificationCreationException;
/**
*
* @return the clock app
*/
- public @Nullable Application getClock();
+ @Nullable
+ Application getClock();
/**
* Get the built-in countdown timer application. This application counts
*
* @return the countdown app
*/
- public @Nullable Application getCountdown();
+ @Nullable
+ Application getCountdown();
/**
* Get the built-in radio application. The radio can play streams from the
*
* @return the radio app
*/
- public @Nullable Application getRadio();
+ @Nullable
+ Application getRadio();
/**
* Get the built-in stopwatch application. The stopwatch counts time
*
* @return the stopwatch app
*/
- public @Nullable Application getStopwatch();
+ @Nullable
+ Application getStopwatch();
/**
* Get the built-in weather application. This application displays the
*
* @return the weather app
*/
- public @Nullable Application getWeather();
+ @Nullable
+ Application getWeather();
/**
* Get any of the built-in applications.
* the app to retrieve
* @return the requested app
*/
- public @Nullable Application getApplication(CoreApplication coreApp);
+ @Nullable
+ Application getApplication(CoreApplication coreApp);
/**
* Get any application installed on the device.
* @throws ApplicationNotFoundException
* if the requested app is not found on the device
*/
- public @Nullable Application getApplication(@Nullable String name) throws ApplicationNotFoundException;
+ @Nullable
+ Application getApplication(@Nullable String name) throws ApplicationNotFoundException;
/**
* Display the given built-in application on the device.
* @param coreApp
* the app to activate
*/
- public void activateApplication(CoreApplication coreApp);
+ void activateApplication(CoreApplication coreApp);
/**
* Display the first instance (widget) of the given application on the
* @throws ApplicationActivationException
* if the app fails to activate
*/
- public void activateApplication(Application app) throws ApplicationActivationException;
+ void activateApplication(Application app) throws ApplicationActivationException;
/**
* Display the given widget on the device. A widget is simply an instance of
* @throws ApplicationActivationException
* if the app fails to activate
*/
- public void activateWidget(Widget widget) throws ApplicationActivationException;
+ void activateWidget(Widget widget) throws ApplicationActivationException;
/**
* Perform the given action on the first instance (widget) of the
* @param coreAction
* the action to perform
*/
- public void doAction(CoreAction coreAction);
+ void doAction(CoreAction coreAction);
/**
* Perform the given action on the first instance (widget) of the given
* @throws ApplicationActionException
* if the action cannot be performed
*/
- public void doAction(Application app, UpdateAction action) throws ApplicationActionException;
+ void doAction(Application app, UpdateAction action) throws ApplicationActionException;
/**
* Perform the given core action on the given widget. A widget is simply an
* @throws ApplicationActionException
* if the action cannot be performed
*/
- public void doAction(@Nullable Widget widget, CoreAction action) throws ApplicationActionException;
+ void doAction(@Nullable Widget widget, CoreAction action) throws ApplicationActionException;
/**
* Perform the given action on the given widget. A widget is simply an
* @throws ApplicationActionException
* if the action cannot be performed
*/
- public void doAction(Widget widget, UpdateAction action) throws ApplicationActionException;
+ void doAction(Widget widget, UpdateAction action) throws ApplicationActionException;
/**
* Set the display brightness. The {@link #setBrightnessMode(BrightnessMode)
* @throws UpdateException
* if the update failed
*/
- public Display setBrightness(int brightness) throws UpdateException;
+ Display setBrightness(int brightness) throws UpdateException;
/**
* Set the brightness mode on the display. {@link BrightnessMode#MANUAL}
* @throws UpdateException
* if the update failed
*/
- public Display setBrightnessMode(BrightnessMode mode) throws UpdateException;
+ Display setBrightnessMode(BrightnessMode mode) throws UpdateException;
/**
* Set the speaker volume on the device.
* @throws UpdateException
* if the update failed
*/
- public Audio setVolume(int volume) throws UpdateException;
+ Audio setVolume(int volume) throws UpdateException;
/**
* Mute the device's speakers. The current volume will be stored so that
* @throws UpdateException
* if the update failed
*/
- public Audio mute() throws UpdateException;
+ Audio mute() throws UpdateException;
/**
* Restore the volume prior to {@link #mute()}. If the volume has not been
* @throws UpdateException
* if the update failed
*/
- public Audio unmute() throws UpdateException;
+ Audio unmute() throws UpdateException;
/**
* Set the active state of the Bluetooth radio on the device.
* @throws UpdateException
* if the update failed
*/
- public Bluetooth setBluetoothActive(boolean active) throws UpdateException;
+ Bluetooth setBluetoothActive(boolean active) throws UpdateException;
/**
* Set the device name as seen via Bluetooth connectivity.
* @throws UpdateException
* if the update failed
*/
- public Bluetooth setBluetoothName(String name) throws UpdateException;
+ Bluetooth setBluetoothName(String name) throws UpdateException;
/**
* Get the local API for more advanced interactions as well device inquiry.
*
* @return the local API
*/
- public LaMetricTimeLocal getLocalApi();
+ LaMetricTimeLocal getLocalApi();
/**
* Get the cloud API for interacting with LaMetric's services.
*
* @return the cloud API
*/
- public LaMetricTimeCloud getCloudApi();
+ LaMetricTimeCloud getCloudApi();
/**
* Create an instance of this API. For greater control over the
* the configuration parameters that the new instance will use
* @return the API instance
*/
- public static LaMetricTime create(Configuration config) {
+ static LaMetricTime create(Configuration config) {
return new LaMetricTimeImpl(config);
}
* communicating with the device and cloud services
* @return the API instance
*/
- public static LaMetricTime create(Configuration config, ClientBuilder clientBuilder) {
+ static LaMetricTime create(Configuration config, ClientBuilder clientBuilder) {
return new LaMetricTimeImpl(config, clientBuilder);
}
* the cloud API configuration for the new instance
* @return the API instance
*/
- public static LaMetricTime create(LocalConfiguration localConfig, CloudConfiguration cloudConfig) {
+ static LaMetricTime create(LocalConfiguration localConfig, CloudConfiguration cloudConfig) {
return new LaMetricTimeImpl(localConfig, cloudConfig);
}
* communicating with the device and cloud services
* @return the API instance
*/
- public static LaMetricTime create(LocalConfiguration localConfig, CloudConfiguration cloudConfig,
+ static LaMetricTime create(LocalConfiguration localConfig, CloudConfiguration cloudConfig,
ClientBuilder clientBuilder) {
return new LaMetricTimeImpl(localConfig, cloudConfig, clientBuilder);
}
*/
@NonNullByDefault
public interface LaMetricTimeCloud {
- public Icons getIcons();
+ Icons getIcons();
- public Icons getIcons(IconFilter filter);
+ Icons getIcons(IconFilter filter);
- public static LaMetricTimeCloud create(CloudConfiguration config) {
+ static LaMetricTimeCloud create(CloudConfiguration config) {
return new LaMetricTimeCloudImpl(config);
}
- public static LaMetricTimeCloud create(CloudConfiguration config, ClientBuilder clientBuilder) {
+ static LaMetricTimeCloud create(CloudConfiguration config, ClientBuilder clientBuilder) {
return new LaMetricTimeCloudImpl(config, clientBuilder);
}
}
* @author Gregory Moyer - Initial contribution
*/
public interface ApiValue {
- public String toRaw();
+ String toRaw();
- public static String raw(ApiValue value) {
+ static String raw(ApiValue value) {
if (value == null) {
return null;
}
*/
@NonNullByDefault
public interface LaMetricTimeLocal {
- public Api getApi();
+ Api getApi();
- public Device getDevice();
+ Device getDevice();
- public String createNotification(Notification notification) throws NotificationCreationException;
+ String createNotification(Notification notification) throws NotificationCreationException;
- public List<Notification> getNotifications();
+ List<Notification> getNotifications();
- public @Nullable Notification getCurrentNotification();
+ @Nullable
+ Notification getCurrentNotification();
- public Notification getNotification(String id) throws NotificationNotFoundException;
+ Notification getNotification(String id) throws NotificationNotFoundException;
- public void deleteNotification(String id) throws NotificationNotFoundException;
+ void deleteNotification(String id) throws NotificationNotFoundException;
- public Display getDisplay();
+ Display getDisplay();
- public Display updateDisplay(Display display) throws UpdateException;
+ Display updateDisplay(Display display) throws UpdateException;
- public Audio getAudio();
+ Audio getAudio();
- public Audio updateAudio(Audio audio) throws UpdateException;
+ Audio updateAudio(Audio audio) throws UpdateException;
- public Bluetooth getBluetooth();
+ Bluetooth getBluetooth();
- public Bluetooth updateBluetooth(Bluetooth bluetooth) throws UpdateException;
+ Bluetooth updateBluetooth(Bluetooth bluetooth) throws UpdateException;
- public Wifi getWifi();
+ Wifi getWifi();
- public void updateApplication(String packageName, String accessToken, WidgetUpdates widgetUpdates)
- throws UpdateException;
+ void updateApplication(String packageName, String accessToken, WidgetUpdates widgetUpdates) throws UpdateException;
- public SortedMap<String, Application> getApplications();
+ SortedMap<String, Application> getApplications();
- public @Nullable Application getApplication(String packageName) throws ApplicationNotFoundException;
+ @Nullable
+ Application getApplication(String packageName) throws ApplicationNotFoundException;
- public void activatePreviousApplication();
+ void activatePreviousApplication();
- public void activateNextApplication();
+ void activateNextApplication();
- public void activateApplication(String packageName, String widgetId) throws ApplicationActivationException;
+ void activateApplication(String packageName, String widgetId) throws ApplicationActivationException;
- public void doAction(String packageName, String widgetId, @Nullable UpdateAction action)
- throws ApplicationActionException;
+ void doAction(String packageName, String widgetId, @Nullable UpdateAction action) throws ApplicationActionException;
- public static LaMetricTimeLocal create(LocalConfiguration config) {
+ static LaMetricTimeLocal create(LocalConfiguration config) {
return new LaMetricTimeLocalImpl(config);
}
- public static LaMetricTimeLocal create(LocalConfiguration config, ClientBuilder clientBuilder) {
+ static LaMetricTimeLocal create(LocalConfiguration config, ClientBuilder clientBuilder) {
return new LaMetricTimeLocalImpl(config, clientBuilder);
}
}
*
* @return the {@link Widget}
*/
- public @Nullable Widget getWidget();
+ @Nullable
+ Widget getWidget();
}
* @throws IllegalArgumentException when an empty packet could not be created or the data in the buffer
* could not be parsed
*/
- public abstract T handle(ByteBuffer buf);
+ T handle(ByteBuffer buf);
}
*
* @param packet the updated properties
*/
- public void handlePropertiesUpdate(Map<String, String> properties);
+ void handlePropertiesUpdate(Map<String, String> properties);
}
*
* @param packet the received packet
*/
- public void handleResponsePacket(Packet packet);
+ void handleResponsePacket(Packet packet);
}
@NonNullByDefault
public interface KeypadComponent {
- public int id();
+ int id();
- public String channel();
+ String channel();
- public String description();
+ String description();
- public ComponentType type();
+ ComponentType type();
}
*
* @param response a non-null, possibly empty response
*/
- public void responseReceived(String response);
+ void responseReceived(String response);
/**
* Called when a command finished with an exception
*
* @param e a non-null exception
*/
- public void responseException(Exception e);
+ void responseException(Exception e);
}
@NonNullByDefault
public interface LeapMessageParserCallbacks {
- public void validMessageReceived(String communiqueType);
+ void validMessageReceived(String communiqueType);
- public void handleEmptyButtonGroupDefinition();
+ void handleEmptyButtonGroupDefinition();
- public void handleZoneUpdate(ZoneStatus zoneStatus);
+ void handleZoneUpdate(ZoneStatus zoneStatus);
- public void handleGroupUpdate(int groupNumber, String occupancyStatus);
+ void handleGroupUpdate(int groupNumber, String occupancyStatus);
- public void handleMultipleButtonGroupDefinition(List<ButtonGroup> buttonGroupList);
+ void handleMultipleButtonGroupDefinition(List<ButtonGroup> buttonGroupList);
- public void handleMultipleDeviceDefintion(List<Device> deviceList);
+ void handleMultipleDeviceDefintion(List<Device> deviceList);
-
public void handleMultipleAreaDefinition(List<Area> areaList);
+ void handleMultipleAreaDefinition(List<Area> areaList);
- public void handleMultipleOccupancyGroupDefinition(List<OccupancyGroup> oGroupList);
+ void handleMultipleOccupancyGroupDefinition(List<OccupancyGroup> oGroupList);
}
@NonNullByDefault
public interface RadioRAConnection {
- public void open(String portName, int baud) throws RadioRAConnectionException;
+ void open(String portName, int baud) throws RadioRAConnectionException;
- public void disconnect();
+ void disconnect();
- public void write(String command);
+ void write(String command);
- public void setListener(RadioRAFeedbackListener listener);
+ void setListener(RadioRAFeedbackListener listener);
}
*
* @param data a line of data from the meteoStick
*/
- public void onDataReceived(String data[]);
+ void onDataReceived(String data[]);
}
*
* @param accessToken The new access token.
*/
- public void onNewAccessToken(String accessToken);
+ void onNewAccessToken(String accessToken);
}
* @throws OAuthException if the listener needs to be registered at an underlying service which is not available
* because the account has not yet been authorized
*/
- public void setRefreshListener(OAuthTokenRefreshListener listener, String serviceHandle);
+ void setRefreshListener(OAuthTokenRefreshListener listener, String serviceHandle);
/**
* Unsets a listener.
*
* @param serviceHandle The service handle identifying the internal OAuth configuration.
*/
- public void unsetRefreshListener(String serviceHandle);
+ void unsetRefreshListener(String serviceHandle);
/**
* Refreshes the access and refresh tokens for the given service handle. If an {@link OAuthTokenRefreshListener} is
* @param serviceHandle The service handle identifying the internal OAuth configuration.
* @throws OAuthException if the token cannot be obtained or refreshed
*/
- public void refreshToken(String serviceHandle);
+ void refreshToken(String serviceHandle);
/**
* Gets the currently stored access token from persistent storage.
* @param serviceHandle The service handle identifying the internal OAuth configuration.
* @return The currently stored access token or an empty {@link Optional} if there is no stored token.
*/
- public Optional<String> getAccessTokenFromStorage(String serviceHandle);
+ Optional<String> getAccessTokenFromStorage(String serviceHandle);
/**
* Removes the tokens from persistent storage.
*
* @param serviceHandle The service handle identifying the internal OAuth configuration.
*/
- public void removeTokensFromStorage(String serviceHandle);
+ void removeTokensFromStorage(String serviceHandle);
}
* @param configuration The configuration holding all required parameters to construct the instance.
* @return A new {@link MieleWebservice}.
*/
- public MieleWebservice create(MieleWebserviceConfiguration configuration);
+ MieleWebservice create(MieleWebserviceConfiguration configuration);
}
*/
@NonNullByDefault
public interface Data {
- public enum DataType {
+ enum DataType {
INFO,
POWER,
WALLBOX,
* Discovery participant should call this method when a new
* thing has been discovered
*/
- public void thingDiscovered(DiscoveryResult result);
+ void thingDiscovered(DiscoveryResult result);
/**
* This method should be called once the discovery has been finished
* or aborted by any error.
* It is important to call this even when there were no things discovered.
*/
- public void discoveryFinished();
+ void discoveryFinished();
}
*
* @return a set of thing type UIDs for which results can be created
*/
- public Set<ThingTypeUID> getSupportedThingTypeUIDs();
+ Set<ThingTypeUID> getSupportedThingTypeUIDs();
/**
* Start an asynchronous discovery process of a Modbus endpoint
*
* @param handler the endpoint that should be discovered
*/
- public void startDiscovery(ModbusEndpointThingHandler handler, ModbusDiscoveryListener listener);
+ void startDiscovery(ModbusEndpointThingHandler handler, ModbusDiscoveryListener listener);
}
* @param service the discovery service that should be called when the discovery is finished
* @return returns true if discovery is enabled, false otherwise
*/
- public boolean startScan(ModbusDiscoveryService service);
+ boolean startScan(ModbusDiscoveryService service);
/**
* This method should return true, if an async scan is in progress
*
* @return true if a scan is in progress false otherwise
*/
- public boolean scanInProgress();
+ boolean scanInProgress();
}
*
* @return communication interface represented by this thing handler
*/
- public @Nullable ModbusCommunicationInterface getCommunicationInterface();
+ @Nullable
+ ModbusCommunicationInterface getCommunicationInterface();
/**
* Get Slave ID, also called as unit id, represented by the thing
* @return slave id represented by this thing handler
* @throws EndpointNotInitializedException in case the initialization is not complete
*/
- public int getSlaveId() throws EndpointNotInitializedException;
+ int getSlaveId() throws EndpointNotInitializedException;
/**
* Return true if auto discovery is enabled for this endpoint
*
* @return boolean true if the discovery is enabled
*/
- public boolean isDiscoveryEnabled();
+ boolean isDiscoveryEnabled();
}
*
* @param event the MonopriceAudioMessageEvent
*/
- public void onNewMessageEvent(MonopriceAudioMessageEvent event);
+ void onNewMessageEvent(MonopriceAudioMessageEvent event);
}
* @param payload_available
* @param payload_not_available
*/
- public void addAvailabilityTopic(String availability_topic, String payload_available, String payload_not_available);
+ void addAvailabilityTopic(String availability_topic, String payload_available, String payload_not_available);
/**
* Adds an availability topic to determine the availability of a device.
* @param transformationServiceProvider The service provider to obtain the transformation service (required only if
* transformation_pattern is not null).
*/
- public void addAvailabilityTopic(String availability_topic, String payload_available, String payload_not_available,
+ void addAvailabilityTopic(String availability_topic, String payload_available, String payload_not_available,
@Nullable String transformation_pattern,
@Nullable TransformationServiceProvider transformationServiceProvider);
- public void removeAvailabilityTopic(String availability_topic);
+ void removeAvailabilityTopic(String availability_topic);
- public void clearAllAvailabilityTopics();
+ void clearAllAvailabilityTopics();
/**
* resets the indicator, if messages have been received.
* <p>
* This is used to time out the availability of the device after some time without receiving a message.
*/
- public void resetMessageReceived();
+ void resetMessageReceived();
}
@NonNullByDefault
public interface ByteResponseCallback extends ResponseCallback {
- public void onResponse(byte[] result);
+ void onResponse(byte[] result);
}
*/
@NonNullByDefault
public interface ResponseCallback {
- public void onError(NetworkError error);
+ void onError(NetworkError error);
}
@NonNullByDefault
public interface StringResponseCallback extends ResponseCallback {
- public void onResponse(@Nullable String result);
+ void onResponse(@Nullable String result);
}
@NonNullByDefault
public interface ChannelCommandHandler {
- public void handleCommand(Command command);
+ void handleCommand(Command command);
}
@NonNullByDefault
public interface MyNiceDataListener {
- public void onDataFetched(List<Device> devices);
+ void onDataFetched(List<Device> devices);
}
*/
@NonNullByDefault
public interface MyQDeviceHandler {
- public void handleDeviceUpdate(DeviceDTO device);
+ void handleDeviceUpdate(DeviceDTO device);
- public String getSerialNumber();
+ String getSerialNumber();
}
*/
@NonNullByDefault
public interface LocationEx extends Location {
- public Optional<String> getCountry();
+ Optional<String> getCountry();
- public Optional<String> getTimezone();
+ Optional<String> getTimezone();
}
*/
@NonNullByDefault
public interface NAModule {
- public String getId();
+ String getId();
- public @Nullable String getName();
+ @Nullable
+ String getName();
- public ModuleType getType();
+ ModuleType getType();
}
* A partial result always means that the device is reachable, but not
* all methods have returned a value yet.
*/
- public void partialDetectionResult(PresenceDetectionValue value);
+ void partialDetectionResult(PresenceDetectionValue value);
/**
* This method is called by the {@see PresenceDetectionService}
*
* @param value The final result of the presence detection process.
*/
- public void finalDetectionResult(PresenceDetectionValue value);
+ void finalDetectionResult(PresenceDetectionValue value);
}
@NonNullByDefault
public interface NibeUplinkCommand extends SuccessListener, FailureListener, ContentListener, CompleteListener {
- public static int MAX_RETRIES = 5;
+ static int MAX_RETRIES = 5;
/**
* this method is to be called by the UplinkWebinterface class
*
* @param state
*/
- public void actionEvent(int state);
+ void actionEvent(int state);
/**
* Called to indicate the action has been initialized.
*
*/
- public void actionInitialized();
+ void actionInitialized();
/**
* Called to indicate the action has been removed from the Niko Home Control controller.
*
*/
- public void actionRemoved();
+ void actionRemoved();
}
*
* @return the addr
*/
- public default @Nullable InetAddress getAddr() {
+ default @Nullable InetAddress getAddr() {
return null;
}
*
* @return the port
*/
- public default int getPort() {
+ default int getPort() {
return 0;
}
*
* @return the profile
*/
- public default String getProfile() {
+ default String getProfile() {
return "";
}
*
* @return the token
*/
- public default String getToken() {
+ default String getToken() {
return "";
}
*
* @return the zone ID
*/
- public ZoneId getTimeZone();
+ ZoneId getTimeZone();
/**
* Called to indicate the connection with the Niko Home Control Controller is offline.
*
* @param message
*/
- public void controllerOffline(String message);
+ void controllerOffline(String message);
/**
* Called to indicate the connection with the Niko Home Control Controller is online.
*
*/
- public void controllerOnline();
+ void controllerOnline();
/**
* This method is called when an alarm event is received from the Niko Home Control controller.
*
* @param alarmText
*/
- public void alarmEvent(String alarmText);
+ void alarmEvent(String alarmText);
/**
* This method is called when a notice event is received from the Niko Home Control controller.
*
* @param alarmText
*/
- public void noticeEvent(String noticeText);
+ void noticeEvent(String noticeText);
/**
* This method is called when properties are updated from the Niko Home Control controller.
*/
- public void updatePropertiesEvent();
+ void updatePropertiesEvent();
}
*
* @param power current power consumption/production in W (positive for consumption), null for an empty reading
*/
- public void energyMeterEvent(@Nullable Integer power);
+ void energyMeterEvent(@Nullable Integer power);
/**
* Called to indicate the energyMeter has been initialized.
*
*/
- public void energyMeterInitialized();
+ void energyMeterInitialized();
/**
* Called to indicate the energyMeter has been removed from the Niko Home Control controller.
*
*/
- public void energyMeterRemoved();
+ void energyMeterRemoved();
}
* @param overrule the overrule temperature in 0.1°C multiples
* @param demand 0 if no demand, > 0 if heating, < 0 if cooling
*/
- public void thermostatEvent(int measured, int setpoint, int mode, int overrule, int demand);
+ void thermostatEvent(int measured, int setpoint, int mode, int overrule, int demand);
/**
* Called to indicate the thermostat has been initialized.
*
*/
- public void thermostatInitialized();
+ void thermostatInitialized();
/**
* Called to indicate the thermostat has been removed from the Niko Home Control controller.
*
*/
- public void thermostatRemoved();
+ void thermostatRemoved();
}
*
* @param event the NuvoMessageEvent object
*/
- public void onNewMessageEvent(NuvoMessageEvent event);
+ void onNewMessageEvent(NuvoMessageEvent event);
}
*
* @return True if this API interface is connected to the Open Sprinkler API. False otherwise.
*/
- public abstract boolean isManualModeEnabled();
+ boolean isManualModeEnabled();
/**
* Enters the "manual" mode of the device so that API requests are accepted.
*
* @throws Exception
*/
- public abstract void enterManualMode() throws CommunicationApiException, UnauthorizedApiException;
+ void enterManualMode() throws CommunicationApiException, UnauthorizedApiException;
/**
* Disables the manual mode, if it is enabled.
*
* @throws Exception
*/
- public abstract void leaveManualMode() throws CommunicationApiException, UnauthorizedApiException;
+ void leaveManualMode() throws CommunicationApiException, UnauthorizedApiException;
/**
* Starts a station on the OpenSprinkler device for the specified duration.
* @param duration The duration in seconds for how long the station should be turned on.
* @throws Exception
*/
- public abstract void openStation(int station, BigDecimal duration)
- throws CommunicationApiException, GeneralApiException;
+ void openStation(int station, BigDecimal duration) throws CommunicationApiException, GeneralApiException;
/**
* Closes a station on the OpenSprinkler device.
* @param station Index of the station to open starting at 0.
* @throws Exception
*/
- public abstract void closeStation(int station) throws CommunicationApiException, GeneralApiException;
+ void closeStation(int station) throws CommunicationApiException, GeneralApiException;
/**
* Returns the state of a station on the OpenSprinkler device.
* @return True if the station is open, false if it is closed or cannot determine.
* @throws Exception
*/
- public abstract boolean isStationOpen(int station) throws CommunicationApiException, GeneralApiException;
+ boolean isStationOpen(int station) throws CommunicationApiException, GeneralApiException;
/**
* Returns the current program data of the requested station.
* @return StationProgram
* @throws Exception
*/
- public abstract StationProgram retrieveProgram(int station) throws CommunicationApiException;
+ StationProgram retrieveProgram(int station) throws CommunicationApiException;
/**
* Returns the state of rain detection on the OpenSprinkler device.
* @return True if rain is detected, false if not or cannot determine.
* @throws Exception
*/
- public abstract boolean isRainDetected();
+ boolean isRainDetected();
/**
* Returns the current draw of all connected zones of the OpenSprinkler device in milliamperes.
*
* @return current draw in milliamperes or -1 if sensor not supported
*/
- public abstract int currentDraw();
+ int currentDraw();
/**
* Returns the state of the second sensor.
*
* @return 1: sensor is active; 0: sensor is inactive; -1: no sensor.
*/
- public abstract int getSensor2State();
+ int getSensor2State();
/**
*
* @return The Wifi signal strength in -dB or 0 if not supported by firmware
*/
- public abstract int signalStrength();
+ int signalStrength();
/**
*
* @return The pulses that the flow sensor has given in the last time period, -1 if not supported.
*/
- public abstract int flowSensorCount();
+ int flowSensorCount();
/**
* CLOSES all stations turning them all off.
*
*/
- public abstract void resetStations() throws UnauthorizedApiException, CommunicationApiException;
+ void resetStations() throws UnauthorizedApiException, CommunicationApiException;
/**
* Returns true if the internal programs are allowed to auto start.
*
* @return true if enabled
*/
- public abstract boolean getIsEnabled();
+ boolean getIsEnabled();
- public abstract void enablePrograms(Command command) throws UnauthorizedApiException, CommunicationApiException;
+ void enablePrograms(Command command) throws UnauthorizedApiException, CommunicationApiException;
/**
* Returns the water level in %.
*
* @return waterLevel in %
*/
- public abstract int waterLevel();
+ int waterLevel();
/**
* Returns the number of total stations that are controllable from the OpenSprinkler
*
* @return Number of stations as an int.
*/
- public abstract int getNumberOfStations();
+ int getNumberOfStations();
/**
* Returns the firmware version number.
* @return The firmware version of the OpenSprinkler device as an int.
* @throws Exception
*/
- public abstract int getFirmwareVersion() throws CommunicationApiException, UnauthorizedApiException;
+ int getFirmwareVersion() throws CommunicationApiException, UnauthorizedApiException;
/**
* Sends all the GET requests and stores/cache the responses for use by the API to prevent the need for multiple
* @throws CommunicationApiException
* @throws UnauthorizedApiException
*/
- public abstract void refresh() throws CommunicationApiException, UnauthorizedApiException;
+ void refresh() throws CommunicationApiException, UnauthorizedApiException;
/**
* Ask the OpenSprinkler for the program names and store these for future use in a List.
* @throws CommunicationApiException
* @throws UnauthorizedApiException
*/
- public abstract void getProgramData() throws CommunicationApiException, UnauthorizedApiException;
+ void getProgramData() throws CommunicationApiException, UnauthorizedApiException;
/**
* Returns a list of all internal programs as a list of StateOptions.
*
* @return List<StateOption>
*/
- public abstract List<StateOption> getPrograms();
+ List<StateOption> getPrograms();
/**
* Return a list of all the stations the device has as List of StateOptions
*
* @return List<StateOption>
*/
- public abstract List<StateOption> getStations();
+ List<StateOption> getStations();
/**
* Runs a Program that is setup and stored inside the OpenSprinkler
* @throws CommunicationApiException
* @throws UnauthorizedApiException
*/
- public abstract void runProgram(Command command) throws CommunicationApiException, UnauthorizedApiException;
+ void runProgram(Command command) throws CommunicationApiException, UnauthorizedApiException;
/**
* Fetch the station names and place them in a list of List<StateOption>.
* @throws CommunicationApiException
* @throws UnauthorizedApiException
*/
- public abstract JnResponse getStationNames() throws CommunicationApiException, UnauthorizedApiException;
+ JnResponse getStationNames() throws CommunicationApiException, UnauthorizedApiException;
/**
* Tells a single station to ignore the rain delay.
* @throws CommunicationApiException
* @throws UnauthorizedApiException
*/
- public void ignoreRain(int station, boolean command) throws CommunicationApiException, UnauthorizedApiException;
+ void ignoreRain(int station, boolean command) throws CommunicationApiException, UnauthorizedApiException;
/**
* Asks if a single station is set to ignore rain delays.
* @param station
* @return
*/
- public abstract boolean isIgnoringRain(int station);
+ boolean isIgnoringRain(int station);
/**
* Sets how long the OpenSprinkler device will stop running programs for.
* @throws UnauthorizedApiException
* @throws CommunicationApiException
*/
- public abstract void setRainDelay(int hours) throws UnauthorizedApiException, CommunicationApiException;
+ void setRainDelay(int hours) throws UnauthorizedApiException, CommunicationApiException;
/**
* Gets the rain delay in hours from the OpenSprinkler device.
*
* @return QuantityType<Time>
*/
- public abstract QuantityType<Time> getRainDelay();
+ QuantityType<Time> getRainDelay();
}
*
* @param event the OppoMessageEvent object
*/
- public void onNewMessageEvent(OppoMessageEvent event);
+ void onNewMessageEvent(OppoMessageEvent event);
}
/**
* Represent a CommandType of command requests
*/
- public interface CommandType {
+ interface CommandType {
/**
* Return the command of this command type.
*
*
* @return
*/
- public String getCommand();
+ String getCommand();
/**
* Return the number of the zone this command will be sent to.
*
* @return
*/
- public int getZone();
+ int getZone();
/**
* Return the the command type of this command.
*
* @return
*/
- public CommandType getCommandType();
+ CommandType getCommandType();
}
*
* @param listener
*/
- public void addUpdateListener(AvrUpdateListener listener);
+ void addUpdateListener(AvrUpdateListener listener);
/**
* Add a disconnection listener. It is notified when the AVR is disconnected.
*
* @param listener
*/
- public void addDisconnectionListener(AvrDisconnectionListener listener);
+ void addDisconnectionListener(AvrDisconnectionListener listener);
/**
* Connect to the receiver. Return true if the connection has succeeded or if already connected.
*
**/
- public boolean connect();
+ boolean connect();
/**
* Return true if this manager is connected to the AVR.
*
* @return
*/
- public boolean isConnected();
+ boolean isConnected();
/**
* Closes the connection.
**/
- public void close();
+ void close();
/**
* Send a power state query to the AVR
* @param zone
* @return
*/
- public boolean sendPowerQuery(int zone);
+ boolean sendPowerQuery(int zone);
/**
* Send a volume level query to the AVR
* @param zone
* @return
*/
- public boolean sendVolumeQuery(int zone);
+ boolean sendVolumeQuery(int zone);
/**
* Send a mute state query to the AVR
* @param zone
* @return
*/
- public boolean sendMuteQuery(int zone);
+ boolean sendMuteQuery(int zone);
/**
* Send a source input state query to the AVR
* @param zone
* @return
*/
- public boolean sendInputSourceQuery(int zone);
+ boolean sendInputSourceQuery(int zone);
/**
* Send a listening mode state query to the AVR
* @param zone
* @return
*/
- public boolean sendListeningModeQuery(int zone);
+ boolean sendListeningModeQuery(int zone);
/**
* Send an MCACC Memory query to the AVR
*
* @return
*/
- public boolean sendMCACCMemoryQuery();
+ boolean sendMCACCMemoryQuery();
/**
* Send a power command ot the AVR based on the openHAB command
* @param zone
* @return
*/
- public boolean sendPowerCommand(Command command, int zone) throws CommandTypeNotSupportedException;
+ boolean sendPowerCommand(Command command, int zone) throws CommandTypeNotSupportedException;
/**
* Send a volume command to the AVR based on the openHAB command
* @param zone
* @return
*/
- public boolean sendVolumeCommand(Command command, int zone) throws CommandTypeNotSupportedException;
+ boolean sendVolumeCommand(Command command, int zone) throws CommandTypeNotSupportedException;
/**
* Send a source input selection command to the AVR based on the openHAB command
* @param zone
* @return
*/
- public boolean sendInputSourceCommand(Command command, int zone) throws CommandTypeNotSupportedException;
+ boolean sendInputSourceCommand(Command command, int zone) throws CommandTypeNotSupportedException;
/**
* Send a listening mode selection command to the AVR based on the openHAB command
* @param zone
* @return
*/
- public boolean sendListeningModeCommand(Command command, int zone) throws CommandTypeNotSupportedException;
+ boolean sendListeningModeCommand(Command command, int zone) throws CommandTypeNotSupportedException;
/**
* Send a mute command to the AVR based on the openHAB command
* @param zone
* @return
*/
- public boolean sendMuteCommand(Command command, int zone) throws CommandTypeNotSupportedException;
+ boolean sendMuteCommand(Command command, int zone) throws CommandTypeNotSupportedException;
/**
* Send an MCACC Memory selection command to the AVR based on the openHAB command
* @param zone
* @return
*/
- public boolean sendMCACCMemoryCommand(Command command) throws CommandTypeNotSupportedException;
+ boolean sendMCACCMemoryCommand(Command command) throws CommandTypeNotSupportedException;
/**
* Return the connection name
*
* @return
*/
- public String getConnectionName();
+ String getConnectionName();
}
/**
* Represent the type of a response.
*/
- public interface AvrResponseType {
+ interface AvrResponseType {
/**
* Return the prefix of the command of this type.
*
* @return
*/
- public ResponseType getResponseType();
+ ResponseType getResponseType();
/**
* Return the parameter of this response or null if the resposne has no parameter.
*
* @return
*/
- public String getParameterValue();
+ String getParameterValue();
/**
* Return true if this response has a parameter.
*
* @return
*/
- public boolean hasParameter();
+ boolean hasParameter();
/**
* Return the zone number which is concerned by this response.
*
* @return
*/
- public Integer getZone();
+ Integer getZone();
}
*
* @param event
*/
- public void onDisconnection(AvrDisconnectionEvent event);
+ void onDisconnection(AvrDisconnectionEvent event);
}
/**
* Procedure for receive status update from Pioneer receiver.
*/
- public void statusUpdateReceived(AvrStatusUpdateEvent event);
+ void statusUpdateReceived(AvrStatusUpdateEvent event);
}
*/
public interface MuteStateValues {
- public static final String ON_VALUE = "0";
- public static final String OFF_VALUE = "1";
+ static final String ON_VALUE = "0";
+ static final String OFF_VALUE = "1";
}
*/
public interface PowerStateValues {
- public static final String ON_VALUE = "0";
- public static final String OFF_VALUE = "1";
- public static final String NETWORK_STANDBY_VALUE = "2";
+ static final String ON_VALUE = "0";
+ static final String OFF_VALUE = "1";
+ static final String NETWORK_STANDBY_VALUE = "2";
}
*/
@NonNullByDefault
public interface Command<ResponseType extends Response<?>> {
- public ResponseType execute() throws ResponseException, IOException, AuthenticationException;
+ ResponseType execute() throws ResponseException, IOException, AuthenticationException;
}
*/
@NonNullByDefault
public interface Request {
- public String getRequestString() throws AuthenticationException;
+ String getRequestString() throws AuthenticationException;
}
*/
@NonNullByDefault
public interface Response<ResponseType> {
- public ResponseType parse(String response) throws ResponseException;
+ ResponseType parse(String response) throws ResponseException;
}
@NonNullByDefault
public interface PlugwiseStickStatusListener {
- public void stickStatusChanged(ThingStatus status);
+ void stickStatusChanged(ThingStatus status);
}
@NonNullByDefault
public interface PlugwiseHAModel {
- public abstract boolean isBatteryOperated();
+ boolean isBatteryOperated();
}
* @author B. van Wetten - Initial contribution
*/
public interface PlugwiseComparableDate<T extends PlugwiseBaseModel> {
- public int compareDateWith(T hasModifiedDate);
+ int compareDateWith(T hasModifiedDate);
- public boolean isOlderThan(T hasModifiedDate);
+ boolean isOlderThan(T hasModifiedDate);
- public boolean isNewerThan(T hasModifiedDate);
+ boolean isNewerThan(T hasModifiedDate);
}
/**
* Method for opening a connection to the Visonic alarm panel.
*/
- public void open() throws Exception;
+ void open() throws Exception;
/**
* Method for closing a connection to the Visonic alarm panel.
*/
- public void close();
+ void close();
/**
* Returns connection status
*
* @return: true if connected or false if not
**/
- public boolean isConnected();
+ boolean isConnected();
/**
* Method for sending a message to the Visonic alarm panel
*
* @param data the message as a table of bytes
**/
- public void sendMessage(byte[] data);
+ void sendMessage(byte[] data);
/**
* Method for reading data from the Visonic alarm panel
*
* @param buffer the buffer into which the data is read
**/
- public int read(byte[] buffer) throws IOException;
+ int read(byte[] buffer) throws IOException;
/**
* Method for registering an event listener
*
* @param listener the listener to be registered
*/
- public void addEventListener(PowermaxMessageEventListener listener);
+ void addEventListener(PowermaxMessageEventListener listener);
/**
* Method for removing an event listener
*
* @param listener the listener to be removed
*/
- public void removeEventListener(PowermaxMessageEventListener listener);
+ void removeEventListener(PowermaxMessageEventListener listener);
}
*
* @param event the event object
*/
- public void onNewMessageEvent(EventObject event);
+ void onNewMessageEvent(EventObject event);
/**
* Event handler method to indicate that communication has been lost
*/
- public void onCommunicationFailure(String message);
+ void onCommunicationFailure(String message);
}
*
* @param settings the updated alarm panel settings or null if the panel settings are unknown
*/
- public void onPanelSettingsUpdated(@Nullable PowermaxPanelSettings settings);
+ void onPanelSettingsUpdated(@Nullable PowermaxPanelSettings settings);
/**
* This method is called when the bridge thing handler identifies
* @param zoneNumber the zone number
* @param settings the updated alarm panel settings or null if the panel settings are unknown
*/
- public void onZoneSettingsUpdated(int zoneNumber, @Nullable PowermaxPanelSettings settings);
+ void onZoneSettingsUpdated(int zoneNumber, @Nullable PowermaxPanelSettings settings);
}
*
* @param event the event object
*/
- public void onNewStateEvent(EventObject event);
+ void onNewStateEvent(EventObject event);
/**
* Event handler method to indicate that communication has been lost
*/
- public void onCommunicationFailure(String message);
+ void onCommunicationFailure(String message);
}
*/
@NonNullByDefault
public interface SerialPortService {
- public InputStream getInputStream(String portId, int baudRate, int numDataBits, int numStopBits, int parity);
+ InputStream getInputStream(String portId, int baudRate, int numDataBits, int numStopBits, int parity);
}
@NonNullByDefault
public interface PulseAudioBindingConfigurationListener {
- public void bindingConfigurationChanged();
+ void bindingConfigurationChanged();
}
* @param bridge The Pulseaudio bridge the added device was connected to.
* @param device The device which is added.
*/
- public void onDeviceAdded(Thing bridge, AbstractAudioDeviceConfig device);
+ void onDeviceAdded(Thing bridge, AbstractAudioDeviceConfig device);
}
*
* @param service
*/
- public void setDiscoveryService(QolsysIQChildDiscoveryService service);
+ void setDiscoveryService(QolsysIQChildDiscoveryService service);
/**
* Initiates the discovery process
*/
- public void startDiscovery();
+ void startDiscovery();
}
*
* @param event the event object
*/
- public void onNewMessageEvent(RadioThermostatEvent event);
+ void onNewMessageEvent(RadioThermostatEvent event);
}
* Connect to the receiver. Return true if the connection has succeeded or if already connected.
*
**/
- public void connect() throws IOException;
+ void connect() throws IOException;
/**
* Return true if this manager is connected to the AVR.
*
* @return
*/
- public boolean isConnected();
+ boolean isConnected();
/**
* Closes the connection.
**/
- public void close();
+ void close();
/**
* Returns an output stream for this connection.
*/
- public OutputStream outputStream() throws IOException;
+ OutputStream outputStream() throws IOException;
/**
* Returns an input stream for this connection.
*/
- public InputStream inputStream() throws IOException;
+ InputStream inputStream() throws IOException;
}
*/
@NonNullByDefault
public interface ResponseParser<T> {
- public int responseLength();
+ int responseLength();
- public T parse(byte[] buffer) throws Rego6xxProtocolException;
+ T parse(byte[] buffer) throws Rego6xxProtocolException;
}
* @author James Hewitt-Thomas - Convert to interface and add validation and matching
*/
public interface RFXComDeviceConfiguration {
- public void parseAndValidate() throws RFXComInvalidParameterException;
+ void parseAndValidate() throws RFXComInvalidParameterException;
- public boolean matchesMessage(RFXComDeviceMessage message);
+ boolean matchesMessage(RFXComDeviceMessage message);
}
* @author James Hewitt-Thomas - Switch to making messages for a specific command
*/
public interface RFXComMessageFactory {
- public RFXComMessage createMessage(PacketType packetType, RFXComDeviceConfiguration config, ChannelUID channelUID,
+ RFXComMessage createMessage(PacketType packetType, RFXComDeviceConfiguration config, ChannelUID channelUID,
Command command) throws RFXComException;
- public RFXComMessage createMessage(byte[] packet) throws RFXComException;
+ RFXComMessage createMessage(byte[] packet) throws RFXComException;
}
*
* @param event the event object
*/
- public void onNewMessageEvent(EventObject event);
+ void onNewMessageEvent(EventObject event);
}
* @param response a non-null, possibly empty response
* @throws InterruptedException if the response processing was interrupted
*/
- public void responseReceived(String response) throws InterruptedException;
+ void responseReceived(String response) throws InterruptedException;
/**
* Called when a command finished with an exception or a general exception occurred while reading
* @param e a non-null io exception
* @throws InterruptedException if the exception processing was interrupted
*/
- public void responseException(IOException e) throws InterruptedException;
+ void responseException(IOException e) throws InterruptedException;
}
* @author Krzysztof Goworek - Initial contribution
*
*/
- public enum State {
+ enum State {
NEW,
ENQUEUED,
SENT,
* @param states list of states
* @return built bit set
*/
- public static BitSet getStatesBitSet(StateType... states) {
+ static BitSet getStatesBitSet(StateType... states) {
BitSet stateBits = new BitSet();
for (StateType state : states) {
stateBits.set(state.getRefreshCommand());
/**
* Marker instance for lack of state type.
*/
- public static final StateType NONE = new StateType() {
+ static final StateType NONE = new StateType() {
@Override
public byte getRefreshCommand() {
*/
public interface ReadingsUpdate {
- public void newState(SeneyeDeviceReading devicereadings);
+ void newState(SeneyeDeviceReading devicereadings);
- public void invalidConfig();
+ void invalidConfig();
}
*/
@NonNullByDefault
public interface ShellyApiInterface {
- public boolean isInitialized();
+ boolean isInitialized();
- public void initialize() throws ShellyApiException;
+ void initialize() throws ShellyApiException;
- public void setConfig(String thingName, ShellyThingConfiguration config);
+ void setConfig(String thingName, ShellyThingConfiguration config);
- public ShellySettingsDevice getDeviceInfo() throws ShellyApiException;
+ ShellySettingsDevice getDeviceInfo() throws ShellyApiException;
- public ShellyDeviceProfile getDeviceProfile(String thingType) throws ShellyApiException;
+ ShellyDeviceProfile getDeviceProfile(String thingType) throws ShellyApiException;
- public ShellySettingsStatus getStatus() throws ShellyApiException;
+ ShellySettingsStatus getStatus() throws ShellyApiException;
- public void setLedStatus(String ledName, Boolean value) throws ShellyApiException;
+ void setLedStatus(String ledName, Boolean value) throws ShellyApiException;
- public void setSleepTime(int value) throws ShellyApiException;
+ void setSleepTime(int value) throws ShellyApiException;
- public ShellyStatusRelay getRelayStatus(int relayIndex) throws ShellyApiException;
+ ShellyStatusRelay getRelayStatus(int relayIndex) throws ShellyApiException;
- public void setRelayTurn(int id, String turnMode) throws ShellyApiException;
+ void setRelayTurn(int id, String turnMode) throws ShellyApiException;
- public ShellyRollerStatus getRollerStatus(int rollerIndex) throws ShellyApiException;
+ ShellyRollerStatus getRollerStatus(int rollerIndex) throws ShellyApiException;
- public void setRollerTurn(int relayIndex, String turnMode) throws ShellyApiException;
+ void setRollerTurn(int relayIndex, String turnMode) throws ShellyApiException;
- public void setRollerPos(int relayIndex, int position) throws ShellyApiException;
+ void setRollerPos(int relayIndex, int position) throws ShellyApiException;
- public void setAutoTimer(int index, String timerName, double value) throws ShellyApiException;
+ void setAutoTimer(int index, String timerName, double value) throws ShellyApiException;
- public ShellyStatusSensor getSensorStatus() throws ShellyApiException;
+ ShellyStatusSensor getSensorStatus() throws ShellyApiException;
- public ShellyStatusLight getLightStatus() throws ShellyApiException;
+ ShellyStatusLight getLightStatus() throws ShellyApiException;
- public ShellyShortLightStatus getLightStatus(int index) throws ShellyApiException;
+ ShellyShortLightStatus getLightStatus(int index) throws ShellyApiException;
- public void setLightMode(String mode) throws ShellyApiException;
+ void setLightMode(String mode) throws ShellyApiException;
- public void setLightParm(int lightIndex, String parm, String value) throws ShellyApiException;
+ void setLightParm(int lightIndex, String parm, String value) throws ShellyApiException;
- public void setLightParms(int lightIndex, Map<String, String> parameters) throws ShellyApiException;
+ void setLightParms(int lightIndex, Map<String, String> parameters) throws ShellyApiException;
- public ShellyShortLightStatus setLightTurn(int id, String turnMode) throws ShellyApiException;
+ ShellyShortLightStatus setLightTurn(int id, String turnMode) throws ShellyApiException;
- public void setBrightness(int id, int brightness, boolean autoOn) throws ShellyApiException;
+ void setBrightness(int id, int brightness, boolean autoOn) throws ShellyApiException;
// Valve
- public void setValveMode(int id, boolean auto) throws ShellyApiException;
+ void setValveMode(int id, boolean auto) throws ShellyApiException;
- public void setValveTemperature(int valveId, int value) throws ShellyApiException;
+ void setValveTemperature(int valveId, int value) throws ShellyApiException;
- public void setValveProfile(int valveId, int value) throws ShellyApiException;
+ void setValveProfile(int valveId, int value) throws ShellyApiException;
- public void setValvePosition(int valveId, double value) throws ShellyApiException;
+ void setValvePosition(int valveId, double value) throws ShellyApiException;
- public void setValveBoostTime(int valveId, int value) throws ShellyApiException;
+ void setValveBoostTime(int valveId, int value) throws ShellyApiException;
- public void startValveBoost(int valveId, int value) throws ShellyApiException;
+ void startValveBoost(int valveId, int value) throws ShellyApiException;
- public ShellyOtaCheckResult checkForUpdate() throws ShellyApiException;
+ ShellyOtaCheckResult checkForUpdate() throws ShellyApiException;
- public ShellySettingsUpdate firmwareUpdate(String uri) throws ShellyApiException;
+ ShellySettingsUpdate firmwareUpdate(String uri) throws ShellyApiException;
- public ShellySettingsLogin getLoginSettings() throws ShellyApiException;
+ ShellySettingsLogin getLoginSettings() throws ShellyApiException;
- public ShellySettingsLogin setLoginCredentials(String user, String password) throws ShellyApiException;
+ ShellySettingsLogin setLoginCredentials(String user, String password) throws ShellyApiException;
- public String setWiFiRecovery(boolean enable) throws ShellyApiException;
+ String setWiFiRecovery(boolean enable) throws ShellyApiException;
- public boolean setWiFiRangeExtender(boolean enable) throws ShellyApiException;
+ boolean setWiFiRangeExtender(boolean enable) throws ShellyApiException;
- public boolean setEthernet(boolean enable) throws ShellyApiException;
+ boolean setEthernet(boolean enable) throws ShellyApiException;
- public boolean setBluetooth(boolean enable) throws ShellyApiException;
+ boolean setBluetooth(boolean enable) throws ShellyApiException;
- public String deviceReboot() throws ShellyApiException;
+ String deviceReboot() throws ShellyApiException;
- public String setDebug(boolean enabled) throws ShellyApiException;
+ String setDebug(boolean enabled) throws ShellyApiException;
- public String getDebugLog(String id) throws ShellyApiException;
+ String getDebugLog(String id) throws ShellyApiException;
- public String setCloud(boolean enabled) throws ShellyApiException;
+ String setCloud(boolean enabled) throws ShellyApiException;
- public String setApRoaming(boolean enable) throws ShellyApiException;
+ String setApRoaming(boolean enable) throws ShellyApiException;
- public String factoryReset() throws ShellyApiException;
+ String factoryReset() throws ShellyApiException;
- public String resetStaCache() throws ShellyApiException;
+ String resetStaCache() throws ShellyApiException;
- public int getTimeoutsRecovered();
+ int getTimeoutsRecovered();
- public int getTimeoutErrors();
+ int getTimeoutErrors();
- public String getCoIoTDescription() throws ShellyApiException;
+ String getCoIoTDescription() throws ShellyApiException;
- public ShellySettingsLogin setCoIoTPeer(String peer) throws ShellyApiException;
+ ShellySettingsLogin setCoIoTPeer(String peer) throws ShellyApiException;
- public void setActionURLs() throws ShellyApiException;
+ void setActionURLs() throws ShellyApiException;
- public void sendIRKey(String keyCode) throws ShellyApiException, IllegalArgumentException;
+ void sendIRKey(String keyCode) throws ShellyApiException, IllegalArgumentException;
- public void close();
+ void close();
}
*/
@NonNullByDefault
public interface Shelly1CoIoTInterface {
- public int getVersion();
+ int getVersion();
- public CoIotDescrSen fixDescription(@Nullable CoIotDescrSen sen, Map<String, CoIotDescrBlk> blkMap);
+ CoIotDescrSen fixDescription(@Nullable CoIotDescrSen sen, Map<String, CoIotDescrBlk> blkMap);
- public void completeMissingSensorDefinition(Map<String, CoIotDescrSen> sensorMap);
+ void completeMissingSensorDefinition(Map<String, CoIotDescrSen> sensorMap);
- public boolean handleStatusUpdate(List<CoIotSensor> sensorUpdates, CoIotDescrSen sen, int serial, CoIotSensor s,
+ boolean handleStatusUpdate(List<CoIotSensor> sensorUpdates, CoIotDescrSen sen, int serial, CoIotSensor s,
Map<String, State> updates, ShellyColorUtils col);
- public String getLastWakeup();
+ String getLastWakeup();
}
*/
@NonNullByDefault
public interface Shelly1CoapListener {
- public void processResponse(@Nullable Response response);
+ void processResponse(@Nullable Response response);
}
@NonNullByDefault
public interface Shelly2RpctInterface {
- public void onConnect(String deviceIp, boolean connected);
+ void onConnect(String deviceIp, boolean connected);
- public void onMessage(String decodedmessage);
+ void onMessage(String decodedmessage);
- public void onNotifyStatus(Shelly2RpcNotifyStatus message);
+ void onNotifyStatus(Shelly2RpcNotifyStatus message);
- public void onNotifyEvent(Shelly2RpcNotifyEvent message);
+ void onNotifyEvent(Shelly2RpcNotifyEvent message);
- public void onClose(int statusCode, String reason);
+ void onClose(int statusCode, String reason);
- public void onError(Throwable cause);
+ void onError(Throwable cause);
}
/**
* This method is called when new device information is received.
*/
- public boolean onEvent(String ipAddress, String deviceName, String deviceIndex, String eventType,
+ boolean onEvent(String ipAddress, String deviceName, String deviceIndex, String eventType,
Map<String, String> parameters);
}
@NonNullByDefault
public interface ShellyManagerInterface {
- public Thing getThing();
+ Thing getThing();
- public String getThingName();
+ String getThingName();
- public ShellyDeviceProfile getProfile();
+ ShellyDeviceProfile getProfile();
- public ShellyDeviceProfile getProfile(boolean forceRefresh) throws ShellyApiException;
+ ShellyDeviceProfile getProfile(boolean forceRefresh) throws ShellyApiException;
- public ShellyApiInterface getApi();
+ ShellyApiInterface getApi();
- public ShellyDeviceStats getStats();
+ ShellyDeviceStats getStats();
- public void resetStats();
+ void resetStats();
- public State getChannelValue(String group, String channel);
+ State getChannelValue(String group, String channel);
- public void setThingOnline();
+ void setThingOnline();
- public void setThingOffline(ThingStatusDetail detail, String messageKey, Object... arguments);
+ void setThingOffline(ThingStatusDetail detail, String messageKey, Object... arguments);
- public boolean requestUpdates(int requestCount, boolean refreshSettings);
+ boolean requestUpdates(int requestCount, boolean refreshSettings);
- public void incProtMessages();
+ void incProtMessages();
- public void incProtErrors();
+ void incProtErrors();
}
@NonNullByDefault
public interface ShellyThingInterface {
- public ShellyDeviceProfile getProfile(boolean forceRefresh) throws ShellyApiException;
+ ShellyDeviceProfile getProfile(boolean forceRefresh) throws ShellyApiException;
- public @Nullable List<StateOption> getStateOptions(ChannelTypeUID uid);
+ @Nullable
+ List<StateOption> getStateOptions(ChannelTypeUID uid);
- public double getChannelDouble(String group, String channel);
+ double getChannelDouble(String group, String channel);
- public boolean updateChannel(String group, String channel, State value);
+ boolean updateChannel(String group, String channel, State value);
- public boolean updateChannel(String channelId, State value, boolean force);
+ boolean updateChannel(String channelId, State value, boolean force);
- public void setThingOnline();
+ void setThingOnline();
- public void setThingOffline(ThingStatusDetail detail, String messageKey, Object... arguments);
+ void setThingOffline(ThingStatusDetail detail, String messageKey, Object... arguments);
- public String getThingType();
+ String getThingType();
- public ThingStatus getThingStatus();
+ ThingStatus getThingStatus();
- public ThingStatusDetail getThingStatusDetail();
+ ThingStatusDetail getThingStatusDetail();
- public boolean isThingOnline();
+ boolean isThingOnline();
- public boolean requestUpdates(int requestCount, boolean refreshSettings);
+ boolean requestUpdates(int requestCount, boolean refreshSettings);
- public void triggerUpdateFromCoap();
+ void triggerUpdateFromCoap();
- public void reinitializeThing();
+ void reinitializeThing();
- public void restartWatchdog();
+ void restartWatchdog();
- public void publishState(String channelId, State value);
+ void publishState(String channelId, State value);
- public boolean areChannelsCreated();
+ boolean areChannelsCreated();
- public State getChannelValue(String group, String channel);
+ State getChannelValue(String group, String channel);
- public boolean updateInputs(ShellySettingsStatus status);
+ boolean updateInputs(ShellySettingsStatus status);
- public void updateChannelDefinitions(Map<String, Channel> dynChannels);
+ void updateChannelDefinitions(Map<String, Channel> dynChannels);
- public void postEvent(String event, boolean force);
+ void postEvent(String event, boolean force);
- public void triggerChannel(String group, String channelID, String event);
+ void triggerChannel(String group, String channelID, String event);
- public void triggerButton(String group, int idx, String value);
+ void triggerButton(String group, int idx, String value);
- public ShellyDeviceStats getStats();
+ ShellyDeviceStats getStats();
- public void resetStats();
+ void resetStats();
- public Thing getThing();
+ Thing getThing();
- public String getThingName();
+ String getThingName();
- public ShellyThingConfiguration getThingConfig();
+ ShellyThingConfiguration getThingConfig();
- public HttpClient getHttpClient();
+ HttpClient getHttpClient();
- public String getProperty(String key);
+ String getProperty(String key);
- public void updateProperties(String key, String value);
+ void updateProperties(String key, String value);
- public boolean updateWakeupReason(@Nullable List<Object> valueArray);
+ boolean updateWakeupReason(@Nullable List<Object> valueArray);
- public ShellyApiInterface getApi();
+ ShellyApiInterface getApi();
- public ShellyDeviceProfile getProfile();
+ ShellyDeviceProfile getProfile();
- public long getScheduledUpdates();
+ long getScheduledUpdates();
- public void fillDeviceStatus(ShellySettingsStatus status, boolean updated);
+ void fillDeviceStatus(ShellySettingsStatus status, boolean updated);
- public boolean checkRepresentation(String key);
+ boolean checkRepresentation(String key);
- public void incProtMessages();
+ void incProtMessages();
- public void incProtErrors();
+ void incProtErrors();
}
*/
@NonNullByDefault
public interface SleepIQConfigStatusMessage {
- public static final String USERNAME_MISSING = "missing-username-configuration";
- public static final String PASSWORD_MISSING = "missing-password-configuration";
+ static final String USERNAME_MISSING = "missing-username-configuration";
+ static final String PASSWORD_MISSING = "missing-password-configuration";
}
* if the login request fails for any reason other than bad
* credentials (including missing credentials)
*/
- public @Nullable LoginInfo login() throws LoginException, UnauthorizedException;
+ @Nullable
+ LoginInfo login() throws LoginException, UnauthorizedException;
/**
* Get a list of beds connected to the account.
* credentials (including missing credentials)
* @throws SleepIQException
*/
- public List<Bed> getBeds() throws LoginException, SleepIQException, BedNotFoundException;
+ List<Bed> getBeds() throws LoginException, SleepIQException, BedNotFoundException;
/**
* Get a list of sleepers registered to this account for beds or bed positions
* @throws LoginException
* @throws SleepIQException
*/
- public List<Sleeper> getSleepers() throws LoginException, SleepIQException;
+ List<Sleeper> getSleepers() throws LoginException, SleepIQException;
/**
* Get the status of all beds and all air chambers registered to this
* @throws LoginException
* @throws SleepIQException
*/
- public FamilyStatusResponse getFamilyStatus() throws LoginException, SleepIQException;
+ FamilyStatusResponse getFamilyStatus() throws LoginException, SleepIQException;
/**
* Get the Sleep Data for a sleeper registered to this account.
* @throws LoginException
* @throws SleepIQException
*/
- public SleepDataResponse getSleepData(String sleeperId, SleepDataInterval interval)
+ SleepDataResponse getSleepData(String sleeperId, SleepDataInterval interval)
throws BedNotFoundException, LoginException, SleepIQException;
/**
* @throws LoginException
* @throws SleepIQException
*/
- public PauseModeResponse getPauseMode(String bedId) throws BedNotFoundException, LoginException, SleepIQException;
+ PauseModeResponse getPauseMode(String bedId) throws BedNotFoundException, LoginException, SleepIQException;
/**
* Set the sleep number for a chamber of a bed
* @throws LoginException
* @throws SleepIQException
*/
- public void setSleepNumber(String bedId, Side side, int sleepNumber) throws LoginException, SleepIQException;
+ void setSleepNumber(String bedId, Side side, int sleepNumber) throws LoginException, SleepIQException;
/**
* Set the pause (privacy) mode for a bed
* @throws LoginException
* @throws SleepIQException
*/
- public void setPauseMode(String bedId, boolean command) throws LoginException, SleepIQException;
+ void setPauseMode(String bedId, boolean command) throws LoginException, SleepIQException;
/**
* Get the foundation features for a bed
* @throws LoginException
* @throws SleepIQException
*/
- public FoundationFeaturesResponse getFoundationFeatures(String bedId) throws LoginException, SleepIQException;
+ FoundationFeaturesResponse getFoundationFeatures(String bedId) throws LoginException, SleepIQException;
/**
* Get the foundation status for a bed
* @throws LoginException
* @throws SleepIQException
*/
- public FoundationStatusResponse getFoundationStatus(String bedId) throws LoginException, SleepIQException;
+ FoundationStatusResponse getFoundationStatus(String bedId) throws LoginException, SleepIQException;
/**
* Set a foundation preset for the side of a bed
* @throws LoginException
* @throws SleepIQException
*/
- public void setFoundationPreset(String bedId, Side side, FoundationPreset preset, FoundationActuatorSpeed speed)
+ void setFoundationPreset(String bedId, Side side, FoundationPreset preset, FoundationActuatorSpeed speed)
throws LoginException, SleepIQException;
/**
* @throws LoginException
* @throws SleepIQException
*/
- public void setFoundationPosition(String bedId, Side side, FoundationActuator actuator, int position,
+ void setFoundationPosition(String bedId, Side side, FoundationActuator actuator, int position,
FoundationActuatorSpeed speed) throws LoginException, SleepIQException;
/**
* @throws LoginException
* @throws SleepIQException
*/
- public void setFoundationOutlet(String bedId, FoundationOutlet outlet, FoundationOutletOperation operation)
+ void setFoundationOutlet(String bedId, FoundationOutlet outlet, FoundationOutletOperation operation)
throws LoginException, SleepIQException;
/**
* @param httpClient handle to the Jetty http client
* @return a concrete implementation of this interface
*/
- public static SleepIQ create(Configuration config, HttpClient httpClient) {
+ static SleepIQ create(Configuration config, HttpClient httpClient) {
return new SleepIQImpl(config, httpClient);
}
/**
* Close down the cloud service
*/
- public void shutdown();
+ void shutdown();
}
*
* @param status the bed status returned from the cloud service
*/
- public void onBedStateChanged(BedStatus status);
+ void onBedStateChanged(BedStatus status);
/**
* This method will be called whenever a new foundation status is received by the cloud handler.
*
* @param status the foundation status returned from the cloud service
*/
- public void onFoundationStateChanged(String bedId, FoundationStatusResponse status);
+ void onFoundationStateChanged(String bedId, FoundationStatusResponse status);
/**
* Determine if bed has a foundation installed.
*
* @return true if bed has a foundation; otherwise falase
*/
- public boolean isFoundationInstalled();
+ boolean isFoundationInstalled();
- public void onSleeperChanged(@Nullable Sleeper sleeper);
+ void onSleeperChanged(@Nullable Sleeper sleeper);
}
*
* @param e The Exception that was thrown.
*/
- public void errorOccurred(Throwable e);
+ void errorOccurred(Throwable e);
/**
* Called whenever some value was added or changed for a meter device.
*
* @param value The changed value.
*/
- public <Q extends Quantity<Q>> void valueChanged(MeterValue<Q> value);
+ <Q extends Quantity<Q>> void valueChanged(MeterValue<Q> value);
/**
* Called whenever some value was removed from the meter device (not available anymore).
*
* @param value The removed value.
*/
- public <Q extends Quantity<Q>> void valueRemoved(MeterValue<Q> value);
+ <Q extends Quantity<Q>> void valueRemoved(MeterValue<Q> value);
}
* @throws TimeoutException
* @throws ExecutionException
*/
- public void sendDeviceCommand(@NonNull String path, int timeout, @NonNull String data)
+ void sendDeviceCommand(@NonNull String path, int timeout, @NonNull String data)
throws InterruptedException, TimeoutException, ExecutionException;
- public ThingUID getBridgeUID();
+ ThingUID getBridgeUID();
}
void setMode(String mode);
- public void setTotalSent(String totalSent);
+ void setTotalSent(String totalSent);
- public void setTotalFailed(String totalFailed);
+ void setTotalFailed(String totalFailed);
- public void setTotalReceived(String totalReceived);
+ void setTotalReceived(String totalReceived);
- public void setTotalFailures(String totalFailure);
+ void setTotalFailures(String totalFailure);
}
*
* @param message The inbound message received
*/
- public void messageReceived(InboundMessage message);
+ void messageReceived(InboundMessage message);
/**
* Implement this method to get warned when
*
* @param message the message sent
*/
- public void messageSent(OutboundMessage message);
+ void messageSent(OutboundMessage message);
/**
* Implement this method to get warned when
*
* @param message the delivery report message
*/
- public void messageDelivered(DeliveryReportMessage message);
+ void messageDelivered(DeliveryReportMessage message);
}
/**
* Initialize logic for the Systeminfo implementation
*/
- public void initializeSysteminfo();
+ void initializeSysteminfo();
// Operating system info
/**
* Get the Family of the operating system /e.g. Windows,Unix,.../
*/
- public StringType getOsFamily();
+ StringType getOsFamily();
/**
* Get the manufacturer of the operating system
*/
- public StringType getOsManufacturer();
+ StringType getOsManufacturer();
/**
* Get the version of the operating system
*
* @return
*/
- public StringType getOsVersion();
+ StringType getOsVersion();
// CPU info
/**
* Get the name of the CPU
*/
- public StringType getCpuName();
+ StringType getCpuName();
/**
* Get description about the CPU e.g (model, family, vendor, serial number, identifier, architecture(32bit or
* 64bit))
*/
- public StringType getCpuDescription();
+ StringType getCpuDescription();
/**
* Get the number of logical CPUs/cores available for processing.
*/
- public DecimalType getCpuLogicalCores();
+ DecimalType getCpuLogicalCores();
/**
* Get the number of physical CPUs/cores available for processing.
*/
- public DecimalType getCpuPhysicalCores();
+ DecimalType getCpuPhysicalCores();
/**
* Returns the system cpu load.
*
* @return the system cpu load between 0 and 100% or null, if no information is available
*/
- public @Nullable PercentType getSystemCpuLoad();
+ @Nullable
+ PercentType getSystemCpuLoad();
/**
* Returns the system load average for the last minute.
*
* @return the load as a number of processes or null, if no information is available
*/
- public @Nullable DecimalType getCpuLoad1();
+ @Nullable
+ DecimalType getCpuLoad1();
/**
* Returns the system load average for the last 5 minutes.
*
* @return the load as number of processes or null, if no information is available
*/
- public @Nullable DecimalType getCpuLoad5();
+ @Nullable
+ DecimalType getCpuLoad5();
/**
* Returns the system load average for the last 15 minutes.
*
* @return the load as number of processes or null, if no information is available
*/
- public @Nullable DecimalType getCpuLoad15();
+ @Nullable
+ DecimalType getCpuLoad15();
/**
* Get the System uptime (time since boot).
*
* @return time since boot
*/
- public QuantityType<Time> getCpuUptime();
+ QuantityType<Time> getCpuUptime();
/**
* Get the number of threads currently running
*
* @return number of threads
*/
- public DecimalType getCpuThreads();
+ DecimalType getCpuThreads();
// Memory info
/**
*
* @return memory size
*/
- public QuantityType<DataAmount> getMemoryTotal();
+ QuantityType<DataAmount> getMemoryTotal();
/**
* Returns available size of memory
*
* @return memory size
*/
- public QuantityType<DataAmount> getMemoryAvailable();
+ QuantityType<DataAmount> getMemoryAvailable();
/**
* Returns used size of memory
*
* @return memory size
*/
- public QuantityType<DataAmount> getMemoryUsed();
+ QuantityType<DataAmount> getMemoryUsed();
/**
* Percents of available memory on the machine
*
* @return percent of available memory or null, if no information is available
*/
- public @Nullable PercentType getMemoryAvailablePercent();
+ @Nullable
+ PercentType getMemoryAvailablePercent();
/**
* Percents of used memory on the machine
*
* @return percent of used memory or null, if no information is available
*/
- public @Nullable PercentType getMemoryUsedPercent();
+ @Nullable
+ PercentType getMemoryUsedPercent();
// Swap memory info
/**
*
* @return memory size or 0, if there is no swap memory
*/
- public QuantityType<DataAmount> getSwapTotal();
+ QuantityType<DataAmount> getSwapTotal();
/**
* Returns available size swap of memory
*
* @return memory size or 0, if no there is no swap memory
*/
- public QuantityType<DataAmount> getSwapAvailable();
+ QuantityType<DataAmount> getSwapAvailable();
/**
* Returns used size of swap memory
*
* @return memory size or 0, if no there is no swap memory
*/
- public QuantityType<DataAmount> getSwapUsed();
+ QuantityType<DataAmount> getSwapUsed();
/**
* Percents of available swap memory on the machine
*
* @return percent of available memory or null, if no there is no swap memory
*/
- public @Nullable PercentType getSwapAvailablePercent();
+ @Nullable
+ PercentType getSwapAvailablePercent();
/**
* Percents of used swap memory on the machine
*
* @return percent of used memory or null, if no there is no swap memory
*/
- public @Nullable PercentType getSwapUsedPercent();
+ @Nullable
+ PercentType getSwapUsedPercent();
// Storage info
/**
* @return storage size
* @throws DeviceNotFoundException
*/
- public QuantityType<DataAmount> getStorageTotal(int deviceIndex) throws DeviceNotFoundException;
+ QuantityType<DataAmount> getStorageTotal(int deviceIndex) throws DeviceNotFoundException;
/**
* Returns the available storage space on the logical storage volume
* @return storage size
* @throws DeviceNotFoundException
*/
- public QuantityType<DataAmount> getStorageAvailable(int deviceIndex) throws DeviceNotFoundException;
+ QuantityType<DataAmount> getStorageAvailable(int deviceIndex) throws DeviceNotFoundException;
/**
* Gets the used storage space on the logical storage volume
* @return storage size
* @throws DeviceNotFoundException
*/
- public QuantityType<DataAmount> getStorageUsed(int deviceIndex) throws DeviceNotFoundException;
+ QuantityType<DataAmount> getStorageUsed(int deviceIndex) throws DeviceNotFoundException;
/**
* Gets the percent of available storage on the logical volume
* @return percent of available storage or null
* @throws DeviceNotFoundException
*/
- public @Nullable PercentType getStorageAvailablePercent(int deviceIndex) throws DeviceNotFoundException;
+ @Nullable
+ PercentType getStorageAvailablePercent(int deviceIndex) throws DeviceNotFoundException;
/**
* Gets the percent of used storage on the logical volume
* @return percent of used storage or null
* @throws DeviceNotFoundException
*/
- public @Nullable PercentType getStorageUsedPercent(int deviceIndex) throws DeviceNotFoundException;
+ @Nullable
+ PercentType getStorageUsedPercent(int deviceIndex) throws DeviceNotFoundException;
/**
* Gets the name of the logical storage volume
*
* @throws DeviceNotFoundException
*/
- public StringType getStorageName(int deviceIndex) throws DeviceNotFoundException;
+ StringType getStorageName(int deviceIndex) throws DeviceNotFoundException;
/**
* Gets the type of the logical storage volume (e.g. NTFS, FAT32)
*
* @throws DeviceNotFoundException
*/
- public StringType getStorageType(int deviceIndex) throws DeviceNotFoundException;
+ StringType getStorageType(int deviceIndex) throws DeviceNotFoundException;
/**
* Gets the description of the logical storage volume
*
* @throws DeviceNotFoundException
*/
- public StringType getStorageDescription(int deviceIndex) throws DeviceNotFoundException;
+ StringType getStorageDescription(int deviceIndex) throws DeviceNotFoundException;
// Hardware drive info
/**
* @param deviceIndex - index of the storage drive
* @throws DeviceNotFoundException
*/
- public StringType getDriveName(int deviceIndex) throws DeviceNotFoundException;
+ StringType getDriveName(int deviceIndex) throws DeviceNotFoundException;
/**
* Gets the model of the physical storage drive
* @param deviceIndex - index of the storage drive
* @throws DeviceNotFoundException
*/
- public StringType getDriveModel(int deviceIndex) throws DeviceNotFoundException;
+ StringType getDriveModel(int deviceIndex) throws DeviceNotFoundException;
/**
* Gets the serial number of the physical storage drive
* @param deviceIndex - index of the storage drive
* @throws DeviceNotFoundException
*/
- public StringType getDriveSerialNumber(int deviceIndex) throws DeviceNotFoundException;
+ StringType getDriveSerialNumber(int deviceIndex) throws DeviceNotFoundException;
// Network info
/**
* @return 32-bit IPv4 address
* @throws DeviceNotFoundException
*/
- public StringType getNetworkIp(int networkIndex) throws DeviceNotFoundException;
+ StringType getNetworkIp(int networkIndex) throws DeviceNotFoundException;
/**
* Get the name of this network.
* @param networkIndex - the index of the network
* @throws DeviceNotFoundException
*/
- public StringType getNetworkName(int networkIndex) throws DeviceNotFoundException;
+ StringType getNetworkName(int networkIndex) throws DeviceNotFoundException;
/**
* The description of the network. On some platforms, this is identical to the name.
* @param networkIndex - the index of the network
* @throws DeviceNotFoundException
*/
- public StringType getNetworkDisplayName(int networkIndex) throws DeviceNotFoundException;
+ StringType getNetworkDisplayName(int networkIndex) throws DeviceNotFoundException;
/**
* Gets the MAC Address of the network.
* @param networkIndex - the index of the network
* @throws DeviceNotFoundException
*/
- public StringType getNetworkMac(int networkIndex) throws DeviceNotFoundException;
+ StringType getNetworkMac(int networkIndex) throws DeviceNotFoundException;
/**
* Get number of packets received
* @param networkIndex - the index of the network
* @throws DeviceNotFoundException
*/
- public DecimalType getNetworkPacketsReceived(int networkIndex) throws DeviceNotFoundException;
+ DecimalType getNetworkPacketsReceived(int networkIndex) throws DeviceNotFoundException;
/**
* Get number of packets sent
* @param networkIndex - the index of the network
* @throws DeviceNotFoundException
*/
- public DecimalType getNetworkPacketsSent(int networkIndex) throws DeviceNotFoundException;
+ DecimalType getNetworkPacketsSent(int networkIndex) throws DeviceNotFoundException;
/**
* Get data sent for this network
* @param networkIndex - the index of the network
* @throws DeviceNotFoundException
*/
- public QuantityType<DataAmount> getNetworkDataSent(int networkIndex) throws DeviceNotFoundException;
+ QuantityType<DataAmount> getNetworkDataSent(int networkIndex) throws DeviceNotFoundException;
/**
* Get data received for this network
* @param networkIndex - the index of the network
* @throws DeviceNotFoundException
*/
- public QuantityType<DataAmount> getNetworkDataReceived(int networkIndex) throws DeviceNotFoundException;
+ QuantityType<DataAmount> getNetworkDataReceived(int networkIndex) throws DeviceNotFoundException;
// Display info
/**
* @param deviceIndex - the index of the display device
* @throws DeviceNotFoundException
*/
- public StringType getDisplayInformation(int deviceIndex) throws DeviceNotFoundException;
+ StringType getDisplayInformation(int deviceIndex) throws DeviceNotFoundException;
// Sensors info
/**
*
* @return Temperature if available, null otherwise.
*/
- public @Nullable QuantityType<Temperature> getSensorsCpuTemperature();
+ @Nullable
+ QuantityType<Temperature> getSensorsCpuTemperature();
/**
* Get the information for the CPU voltage.
*
* @return Voltage if available, null otherwise.
*/
- public @Nullable QuantityType<ElectricPotential> getSensorsCpuVoltage();
+ @Nullable
+ QuantityType<ElectricPotential> getSensorsCpuVoltage();
/**
* Get fan speed
* @return Speed in rpm or null if unable to measure fan speed
* @throws DeviceNotFoundException
*/
- public @Nullable DecimalType getSensorsFanSpeed(int deviceIndex) throws DeviceNotFoundException;
+ @Nullable
+ DecimalType getSensorsFanSpeed(int deviceIndex) throws DeviceNotFoundException;
// Battery info
/**
* @return duration remaining charge or null, if the time is estimated as unlimited
* @throws DeviceNotFoundException
*/
- public @Nullable QuantityType<Time> getBatteryRemainingTime(int deviceIndex) throws DeviceNotFoundException;
+ @Nullable
+ QuantityType<Time> getBatteryRemainingTime(int deviceIndex) throws DeviceNotFoundException;
/**
* Battery remaining capacity.
* @return percentage value
* @throws DeviceNotFoundException
*/
- public PercentType getBatteryRemainingCapacity(int deviceIndex) throws DeviceNotFoundException;
+ PercentType getBatteryRemainingCapacity(int deviceIndex) throws DeviceNotFoundException;
/**
* Get battery name
* @param deviceIndex
* @throws DeviceNotFoundException
*/
- public StringType getBatteryName(int deviceIndex) throws DeviceNotFoundException;
+ StringType getBatteryName(int deviceIndex) throws DeviceNotFoundException;
/**
* Get PID of process executing this code
* @param pid - the PID of the process
* @throws DeviceNotFoundException - thrown if process with this PID can not be found
*/
- public @Nullable StringType getProcessName(int pid) throws DeviceNotFoundException;
+ @Nullable
+ StringType getProcessName(int pid) throws DeviceNotFoundException;
/**
* Returns the CPU usage of the process
* @return - percentage value, can be above 100% if process uses multiple cores
* @throws DeviceNotFoundException - thrown if process with this PID can not be found
*/
- public @Nullable DecimalType getProcessCpuUsage(int pid) throws DeviceNotFoundException;
+ @Nullable
+ DecimalType getProcessCpuUsage(int pid) throws DeviceNotFoundException;
/**
* Returns the size of RAM memory only usage of the process
* @return memory size
* @throws DeviceNotFoundException- thrown if process with this PID can not be found
*/
- public @Nullable QuantityType<DataAmount> getProcessMemoryUsage(int pid) throws DeviceNotFoundException;
+ @Nullable
+ QuantityType<DataAmount> getProcessMemoryUsage(int pid) throws DeviceNotFoundException;
/**
* Returns the full path of the executing process.
* @param pid - the PID of the process
* @throws DeviceNotFoundException - thrown if process with this PID can not be found
*/
- public @Nullable StringType getProcessPath(int pid) throws DeviceNotFoundException;
+ @Nullable
+ StringType getProcessPath(int pid) throws DeviceNotFoundException;
/**
* Returns the number of threads in this process.
* @param pid - the PID of the process
* @throws DeviceNotFoundException - thrown if process with this PID can not be found
*/
- public @Nullable DecimalType getProcessThreads(int pid) throws DeviceNotFoundException;
+ @Nullable
+ DecimalType getProcessThreads(int pid) throws DeviceNotFoundException;
/**
* Returns the number of network interfaces.
*
* @return network interface count
*/
- public int getNetworkIFCount();
+ int getNetworkIFCount();
/**
* Returns the number of displays.
*
* @return display count
*/
- public int getDisplayCount();
+ int getDisplayCount();
/**
* Returns the number of storages.
*
* @return storage count
*/
- public int getFileOSStoreCount();
+ int getFileOSStoreCount();
/**
* Returns the number of power sources/batteries.
*
* @return power source count
*/
- public int getPowerSourceCount();
+ int getPowerSourceCount();
/**
* Returns the number of drives.
*
* @return drive count
*/
- public int getDriveCount();
+ int getDriveCount();
/**
* Returns the number of fans.
* @param device
* The device which received the state update.
*/
- public void onDeviceStateChanged(Bridge bridge, Device device, TellstickEvent deviceEvent);
+ void onDeviceStateChanged(Bridge bridge, Device device, TellstickEvent deviceEvent);
/**
* This method us called whenever a device is removed.
* @param device
* The device which is removed.
*/
- public void onDeviceRemoved(Bridge bridge, Device device);
+ void onDeviceRemoved(Bridge bridge, Device device);
/**
* This method us called whenever a device is added.
* @param device
* The device which is added.
*/
- public void onDeviceAdded(Bridge bridge, Device device);
+ void onDeviceAdded(Bridge bridge, Device device);
}
* @author Karel Goderis - Initial contribution
*/
public interface TimeProvider {
- public static final TimeProvider SYSTEM_PROVIDER = new TimeProvider() {
+ static final TimeProvider SYSTEM_PROVIDER = new TimeProvider() {
@Override
public long getCurrentTimeInMillis() {
return System.currentTimeMillis();
}
};
- public long getCurrentTimeInMillis();
+ long getCurrentTimeInMillis();
}
*
* @param data the received json structure
*/
- public void onUpdate(JsonElement data);
+ void onUpdate(JsonElement data);
/**
* Tells the listener to set the Thing status.
* @param status The thing status
* @param statusDetail the status detail
*/
- public void setStatus(ThingStatus status, ThingStatusDetail statusDetail);
+ void setStatus(ThingStatus status, ThingStatusDetail statusDetail);
}
* @param instanceId The instance id of the device
* @param data the json data describing the device
*/
- public void onUpdate(String instanceId, JsonObject data);
+ void onUpdate(String instanceId, JsonObject data);
}
@NonNullByDefault
public interface UpnpPlaylistsListener {
- public void playlistsListChanged();
+ void playlistsListChanged();
}
* @throws SVDRPConnectionException thrown if connection to VDR failed or was not possible
* @throws SVDRPParseResponseException thrown if something's not OK with SVDRP response
*/
- public void openConnection() throws SVDRPConnectionException, SVDRPParseResponseException;
+ void openConnection() throws SVDRPConnectionException, SVDRPParseResponseException;
/**
* Close VDR Socket Connection
* @throws SVDRPConnectionException thrown if connection to VDR failed or was not possible
* @throws SVDRPParseResponseException thrown if something's not OK with SVDRP response
*/
- public void closeConnection() throws SVDRPConnectionException, SVDRPParseResponseException;
+ void closeConnection() throws SVDRPConnectionException, SVDRPParseResponseException;
/**
* Retrieve Disk Status from SVDRP Client
* @throws SVDRPConnectionException thrown if connection to VDR failed or was not possible
* @throws SVDRPParseResponseException thrown if something's not OK with SVDRP response
*/
- public SVDRPDiskStatus getDiskStatus() throws SVDRPConnectionException, SVDRPParseResponseException;
+ SVDRPDiskStatus getDiskStatus() throws SVDRPConnectionException, SVDRPParseResponseException;
/**
* Retrieve EPG Event from SVDRPClient
* @throws SVDRPConnectionException thrown if connection to VDR failed or was not possible
* @throws SVDRPParseResponseException thrown if something's not OK with SVDRP response
*/
- public SVDRPEpgEvent getEpgEvent(SVDRPEpgEvent.TYPE type)
- throws SVDRPConnectionException, SVDRPParseResponseException;
+ SVDRPEpgEvent getEpgEvent(SVDRPEpgEvent.TYPE type) throws SVDRPConnectionException, SVDRPParseResponseException;
/**
* Retrieve current volume from SVDRP Client
* @throws SVDRPConnectionException thrown if connection to VDR failed or was not possible
* @throws SVDRPParseResponseException thrown if something's not OK with SVDRP response
*/
- public SVDRPVolume getSVDRPVolume() throws SVDRPConnectionException, SVDRPParseResponseException;
+ SVDRPVolume getSVDRPVolume() throws SVDRPConnectionException, SVDRPParseResponseException;
/**
* Set volume on SVDRP Client
* @throws SVDRPConnectionException thrown if connection to VDR failed or was not possible
* @throws SVDRPParseResponseException thrown if something's not OK with SVDRP response
*/
- public SVDRPVolume setSVDRPVolume(int newVolume) throws SVDRPConnectionException, SVDRPParseResponseException;
+ SVDRPVolume setSVDRPVolume(int newVolume) throws SVDRPConnectionException, SVDRPParseResponseException;
/**
* Send Key command to SVDRP Client
* @throws SVDRPConnectionException thrown if connection to VDR failed or was not possible
* @throws SVDRPParseResponseException thrown if something's not OK with SVDRP response
*/
- public void sendSVDRPKey(String key) throws SVDRPConnectionException, SVDRPParseResponseException;
+ void sendSVDRPKey(String key) throws SVDRPConnectionException, SVDRPParseResponseException;
/**
* Send Message to SVDRP Client
* @throws SVDRPConnectionException thrown if connection to VDR failed or was not possible
* @throws SVDRPParseResponseException thrown if something's not OK with SVDRP response
*/
- public void sendSVDRPMessage(String message) throws SVDRPConnectionException, SVDRPParseResponseException;
+ void sendSVDRPMessage(String message) throws SVDRPConnectionException, SVDRPParseResponseException;
/**
* Retrieve current Channel from SVDRP Client
* @throws SVDRPConnectionException thrown if connection to VDR failed or was not possible
* @throws SVDRPParseResponseException thrown if something's not OK with SVDRP response
*/
- public SVDRPChannel getCurrentSVDRPChannel() throws SVDRPConnectionException, SVDRPParseResponseException;
+ SVDRPChannel getCurrentSVDRPChannel() throws SVDRPConnectionException, SVDRPParseResponseException;
/**
* Change current Channel on SVDRP Client
* @throws SVDRPConnectionException thrown if connection to VDR failed or was not possible
* @throws SVDRPParseResponseException thrown if something's not OK with SVDRP response
*/
- public SVDRPChannel setSVDRPChannel(int number) throws SVDRPConnectionException, SVDRPParseResponseException;
+ SVDRPChannel setSVDRPChannel(int number) throws SVDRPConnectionException, SVDRPParseResponseException;
/**
* Retrieve from SVDRP Client if a recording is currently active
* @throws SVDRPConnectionException thrown if connection to VDR failed or was not possible
* @throws SVDRPParseResponseException thrown if something's not OK with SVDRP response
*/
- public boolean isRecordingActive() throws SVDRPConnectionException, SVDRPParseResponseException;
+ boolean isRecordingActive() throws SVDRPConnectionException, SVDRPParseResponseException;
/**
* Retrieve VDR Version from SVDRP Client
* @throws SVDRPConnectionException thrown if connection to VDR failed or was not possible
* @throws SVDRPParseResponseException thrown if something's not OK with SVDRP response
*/
- public String getSVDRPVersion();
+ String getSVDRPVersion();
}
*
* @return VeluxBridgeConfiguration containing all bridge configuration settings.
*/
- public VeluxBridgeConfiguration veluxBridgeConfiguration();
+ VeluxBridgeConfiguration veluxBridgeConfiguration();
/**
* Information retrieved by {@link org.openhab.binding.velux.internal.bridge.VeluxBridgeActuators#getProducts}
*
* @return VeluxExistingProducts containing all registered products, or <B>null</B> in case of any error.
*/
- public VeluxExistingProducts existingProducts();
+ VeluxExistingProducts existingProducts();
/**
* Information retrieved by {@link org.openhab.binding.velux.internal.bridge.VeluxBridgeScenes#getScenes}
*
* @return VeluxExistingScenes containing all registered scenes, or <B>null</B> in case of any error.
*/
- public VeluxExistingScenes existingScenes();
+ VeluxExistingScenes existingScenes();
}
* @return true if communication was successful, and false otherwise.
*/
- public boolean bridgeCommunicate(BridgeCommunicationProtocol communication);
+ boolean bridgeCommunicate(BridgeCommunicationProtocol communication);
/**
* Returns the class {@link BridgeAPI} which summarizes all interfacing methods.
* @return <b>BridgeAPI</b>
* containing all API methods.
*/
- public @Nullable BridgeAPI bridgeAPI();
+ @Nullable
+ BridgeAPI bridgeAPI();
}
*
* @return name of the communication pair for human beings.
*/
- public String name();
+ String name();
/**
* Returns the communication status included within the response message.
*
* @return true if the communication was successful, and false otherwise.
*/
- public boolean isCommunicationSuccessful();
+ boolean isCommunicationSuccessful();
}
/**
* This method returns the thing's class
*/
- public Class<T> getVerisureThingClass();
+ Class<T> getVerisureThingClass();
}
@NonNullByDefault
public interface ThingStatusListener {
- public void thingStatusChanged(Thing thing, ThingStatus status);
+ void thingStatusChanged(Thing thing, ThingStatus status);
}
*/
@NonNullByDefault
public interface WledApi {
- public abstract void update() throws ApiException;
+ void update() throws ApiException;
- public abstract void initialize() throws ApiException;
+ void initialize() throws ApiException;
- public abstract int getFirmwareVersion() throws ApiException;
+ int getFirmwareVersion() throws ApiException;
- public abstract String sendGetRequest(String string) throws ApiException;
+ String sendGetRequest(String string) throws ApiException;
/**
* Turns on/off ALL segments
*/
- public abstract void setGlobalOn(boolean bool) throws ApiException;
+ void setGlobalOn(boolean bool) throws ApiException;
/**
* Turns on/off just THIS segment
*/
- public abstract void setMasterOn(boolean bool, int segmentIndex) throws ApiException;
+ void setMasterOn(boolean bool, int segmentIndex) throws ApiException;
/**
* Sets the brightness of ALL segments
*/
- public abstract void setGlobalBrightness(PercentType percent) throws ApiException;
+ void setGlobalBrightness(PercentType percent) throws ApiException;
/**
* Sets the brightness of just THIS segment
*/
- public abstract void setMasterBrightness(PercentType percent, int segmentIndex) throws ApiException;
+ void setMasterBrightness(PercentType percent, int segmentIndex) throws ApiException;
/**
* Stops any running FX and instantly changes the segment to the desired colour
*/
- public abstract void setMasterHSB(HSBType hsbType, int segmentIndex) throws ApiException;
+ void setMasterHSB(HSBType hsbType, int segmentIndex) throws ApiException;
- public abstract void setEffect(String string, int segmentIndex) throws ApiException;
+ void setEffect(String string, int segmentIndex) throws ApiException;
- public abstract void setPreset(String string) throws ApiException;
+ void setPreset(String string) throws ApiException;
- public abstract void setPalette(String string, int segmentIndex) throws ApiException;
+ void setPalette(String string, int segmentIndex) throws ApiException;
- public abstract void setFxIntencity(PercentType percentType, int segmentIndex) throws ApiException;
+ void setFxIntencity(PercentType percentType, int segmentIndex) throws ApiException;
- public abstract void setFxSpeed(PercentType percentType, int segmentIndex) throws ApiException;
+ void setFxSpeed(PercentType percentType, int segmentIndex) throws ApiException;
- public abstract void setSleep(boolean bool) throws ApiException;
+ void setSleep(boolean bool) throws ApiException;
- public abstract void setSleepMode(String value) throws ApiException;
+ void setSleepMode(String value) throws ApiException;
- public abstract void setSleepDuration(BigDecimal time) throws ApiException;
+ void setSleepDuration(BigDecimal time) throws ApiException;
- public abstract void setSleepTargetBrightness(PercentType percent) throws ApiException;
+ void setSleepTargetBrightness(PercentType percent) throws ApiException;
- public abstract void setUdpSend(boolean bool) throws ApiException;
+ void setUdpSend(boolean bool) throws ApiException;
- public abstract void setUdpRecieve(boolean bool) throws ApiException;
+ void setUdpRecieve(boolean bool) throws ApiException;
- public abstract void setTransitionTime(BigDecimal time) throws ApiException;
+ void setTransitionTime(BigDecimal time) throws ApiException;
- public abstract void setPresetCycle(boolean bool) throws ApiException;
+ void setPresetCycle(boolean bool) throws ApiException;
- public abstract void setPrimaryColor(HSBType hsbType, int segmentIndex) throws ApiException;
+ void setPrimaryColor(HSBType hsbType, int segmentIndex) throws ApiException;
- public abstract void setSecondaryColor(HSBType hsbType, int segmentIndex) throws ApiException;
+ void setSecondaryColor(HSBType hsbType, int segmentIndex) throws ApiException;
- public abstract void setTertiaryColor(HSBType hsbType, int segmentIndex) throws ApiException;
+ void setTertiaryColor(HSBType hsbType, int segmentIndex) throws ApiException;
- public abstract void setWhiteOnly(PercentType percentType, int segmentIndex) throws ApiException;
+ void setWhiteOnly(PercentType percentType, int segmentIndex) throws ApiException;
- public abstract void setMirror(boolean bool, int segmentIndex) throws ApiException;
+ void setMirror(boolean bool, int segmentIndex) throws ApiException;
- public abstract void setReverse(boolean bool, int segmentIndex) throws ApiException;
+ void setReverse(boolean bool, int segmentIndex) throws ApiException;
- public abstract void setLiveOverride(String value) throws ApiException;
+ void setLiveOverride(String value) throws ApiException;
- public abstract void setGrouping(int value, int segmentIndex) throws ApiException;
+ void setGrouping(int value, int segmentIndex) throws ApiException;
- public abstract void setSpacing(int value, int segmentIndex) throws ApiException;
+ void setSpacing(int value, int segmentIndex) throws ApiException;
/**
* Saves a preset to the position number with the supplied name. If the supplied name is an empty String then the
* name 'Preset x' will be used by default using the position number given.
*
*/
- public abstract void savePreset(int position, String presetName) throws ApiException;
+ void savePreset(int position, String presetName) throws ApiException;
- public abstract List<StateOption> getUpdatedFxList();
+ List<StateOption> getUpdatedFxList();
- public abstract List<StateOption> getUpdatedPaletteList();
+ List<StateOption> getUpdatedPaletteList();
- public abstract List<String> getSegmentNames();
+ List<String> getSegmentNames();
}
* @author Pavel Gololobov - Initial contribution
*/
public interface XMPPClientMessageSubscriber {
- public void processMessage(String from, String payload);
+ void processMessage(String from, String payload);
- public String getName();
+ String getName();
}
@NonNullByDefault
public interface WebsocketInterface {
- public void onConnect(boolean connected);
+ void onConnect(boolean connected);
- public void onClose();
+ void onClose();
- public void onMessage(String decodedmessage);
+ void onMessage(String decodedmessage);
- public void onError(Throwable cause);
+ void onError(Throwable cause);
}
* @param item the {@link String} containing item name
* @param command the {@link String} containing a command
*/
- public void sendCommand(String item, String command);
+ void sendCommand(String item, String command);
}
@NonNullByDefault
public interface DynamoDBItemVisitor<T> {
- public T visit(DynamoDBBigDecimalItem dynamoBigDecimalItem);
+ T visit(DynamoDBBigDecimalItem dynamoBigDecimalItem);
- public T visit(DynamoDBStringItem dynamoStringItem);
+ T visit(DynamoDBStringItem dynamoStringItem);
}
projects / openhab-addons.git / commitdiff