demus/openhab-addons
1
0
Fork 0
mirror of https://github.com/openhab/openhab-addons.git synced 2025-01-25 14:55:55 +01:00
Code Issues Packages Projects Releases Wiki Activity

[upnpcontrol] Fix javadoc links (#14471)

Browse Source 
Signed-off-by: Mark Herwege <mark.herwege@telenet.be>
This commit is contained in:
Mark Herwege 2023-02-21 21:11:21 +01:00 committed by GitHub
parent 4f1dd5792f
commit 19db9ee726
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 34 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/audiosink/UpnpAudioSinkReg.java
View File

@ -16,9 +16,9 @@ import org.eclipse.jdt.annotation.NonNullByDefault;
import org.openhab.binding.upnpcontrol.internal.handler.UpnpRendererHandler; import org.openhab.binding.upnpcontrol.internal.handler.UpnpRendererHandler;
/** /**
* Interface class to be implemented in {@link UpnpControlHandlerFactory}, allows a {UpnpRendererHandler} to register * Interface class to be implemented in {@link org.openhab.binding.upnpcontrol.internal.UpnpControlHandlerFactory
* itself as an audio sink when it supports audio. If it supports audio is only known after the communication with the * UpnpControlHandlerFactory}, allows a {@link UpnpRendererHandler} to register itself as an audio sink when it supports
* renderer is established. * audio. If it supports audio is only known after the communication with the renderer is established.
* *
* @author Mark Herwege - Initial contribution * @author Mark Herwege - Initial contribution
*/ */

21
bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/handler/UpnpHandler.java
View File

@ -228,7 +228,8 @@ public abstract class UpnpHandler extends BaseThingHandler implements UpnpIOPart
/** /**
* Method called when a the remote device represented by the thing for this handler is added to the jupnp * Method called when a the remote device represented by the thing for this handler is added to the jupnp
* {@link RegistryListener} or is updated. Configuration info can be retrieved from the {@link RemoteDevice}. * {@link org.jupnp.registry.RegistryListener RegistryListener} or is updated. Configuration info can be retrieved
* from the {@link RemoteDevice}.
* *
* @param device * @param device
*/ */
@ -292,7 +293,7 @@ public abstract class UpnpHandler extends BaseThingHandler implements UpnpIOPart
/** /**
* Invoke PrepareForConnection on the UPnP Connection Manager. * Invoke PrepareForConnection on the UPnP Connection Manager.
* Result is received in {@link onValueReceived}. * Result is received in {@link #onValueReceived}.
* *
* @param remoteProtocolInfo * @param remoteProtocolInfo
* @param peerConnectionManager * @param peerConnectionManager
@ -339,7 +340,7 @@ public abstract class UpnpHandler extends BaseThingHandler implements UpnpIOPart
/** /**
* Invoke GetCurrentConnectionIDs on the UPnP Connection Manager. * Invoke GetCurrentConnectionIDs on the UPnP Connection Manager.
* Result is received in {@link onValueReceived}. * Result is received in {@link #onValueReceived}.
*/ */
protected void getCurrentConnectionIDs() { protected void getCurrentConnectionIDs() {
Map<String, String> inputs = Collections.emptyMap(); Map<String, String> inputs = Collections.emptyMap();
@ -349,7 +350,7 @@ public abstract class UpnpHandler extends BaseThingHandler implements UpnpIOPart
/** /**
* Invoke GetCurrentConnectionInfo on the UPnP Connection Manager. * Invoke GetCurrentConnectionInfo on the UPnP Connection Manager.
* Result is received in {@link onValueReceived}. * Result is received in {@link #onValueReceived}.
*/ */
protected void getCurrentConnectionInfo() { protected void getCurrentConnectionInfo() {
CompletableFuture<Boolean> settingAVTransport = isAvTransportIdSet; CompletableFuture<Boolean> settingAVTransport = isAvTransportIdSet;
@ -373,7 +374,7 @@ public abstract class UpnpHandler extends BaseThingHandler implements UpnpIOPart
/** /**
* Invoke GetFeatureList on the UPnP Connection Manager. * Invoke GetFeatureList on the UPnP Connection Manager.
* Result is received in {@link onValueReceived}. * Result is received in {@link #onValueReceived}.
*/ */
protected void getFeatureList() { protected void getFeatureList() {
Map<String, String> inputs = Collections.emptyMap(); Map<String, String> inputs = Collections.emptyMap();
@ -383,7 +384,7 @@ public abstract class UpnpHandler extends BaseThingHandler implements UpnpIOPart
/** /**
* Invoke GetProtocolInfo on UPnP Connection Manager. * Invoke GetProtocolInfo on UPnP Connection Manager.
* Result is received in {@link onValueReceived}. * Result is received in {@link #onValueReceived}.
*/ */
protected void getProtocolInfo() { protected void getProtocolInfo() {
Map<String, String> inputs = Collections.emptyMap(); Map<String, String> inputs = Collections.emptyMap();
@ -415,10 +416,10 @@ public abstract class UpnpHandler extends BaseThingHandler implements UpnpIOPart
} }
/** /**
* This method wraps {@link org.openhab.core.io.transport.upnp.UpnpIOService.invokeAction}. It schedules and * This method wraps {@link org.openhab.core.io.transport.upnp.UpnpIOService#invokeAction invokeAction}. It
* submits the call and calls {@link onValueReceived} upon completion. All state updates or other actions depending * schedules and submits the call and calls {@link #onValueReceived} upon completion. All state updates or other
* on the results should be triggered from {@link onValueReceived} because the class fields with results will be * actions depending on the results should be triggered from {@link #onValueReceived} because the class fields with
* filled asynchronously. * results will be filled asynchronously.
* *
* @param serviceId * @param serviceId
* @param actionId * @param actionId

16
bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/handler/UpnpRendererHandler.java
View File

@ -453,7 +453,7 @@ public class UpnpRendererHandler extends UpnpHandler {
/** /**
* Invoke GetTransportState on UPnP AV Transport. * Invoke GetTransportState on UPnP AV Transport.
* Result is received in {@link onValueReceived}. * Result is received in {@link #onValueReceived}.
*/ */
protected void getTransportState() { protected void getTransportState() {
Map<String, String> inputs = Collections.singletonMap(INSTANCE_ID, Integer.toString(avTransportId)); Map<String, String> inputs = Collections.singletonMap(INSTANCE_ID, Integer.toString(avTransportId));
@ -463,7 +463,7 @@ public class UpnpRendererHandler extends UpnpHandler {
/** /**
* Invoke getPositionInfo on UPnP AV Transport. * Invoke getPositionInfo on UPnP AV Transport.
* Result is received in {@link onValueReceived}. * Result is received in {@link #onValueReceived}.
*/ */
protected void getPositionInfo() { protected void getPositionInfo() {
Map<String, String> inputs = Collections.singletonMap(INSTANCE_ID, Integer.toString(avTransportId)); Map<String, String> inputs = Collections.singletonMap(INSTANCE_ID, Integer.toString(avTransportId));
@ -473,7 +473,7 @@ public class UpnpRendererHandler extends UpnpHandler {
/** /**
* Invoke GetMediaInfo on UPnP AV Transport. * Invoke GetMediaInfo on UPnP AV Transport.
* Result is received in {@link onValueReceived}. * Result is received in {@link #onValueReceived}.
*/ */
protected void getMediaInfo() { protected void getMediaInfo() {
Map<String, String> inputs = Collections.singletonMap(INSTANCE_ID, Integer.toString(avTransportId)); Map<String, String> inputs = Collections.singletonMap(INSTANCE_ID, Integer.toString(avTransportId));
@ -483,7 +483,9 @@ public class UpnpRendererHandler extends UpnpHandler {
/** /**
* Retrieves the current volume known to the control point, gets updated by GENA events or after UPnP Rendering * Retrieves the current volume known to the control point, gets updated by GENA events or after UPnP Rendering
* Control GetVolume call. This method is used to retrieve volume by {@link UpnpAudioSink.getVolume}. * Control GetVolume call. This method is used to retrieve volume with the
* {@link org.openhab.binding.upnpcontrol.internal.audiosink.UpnpAudioSink#getVolume UpnpAudioSink.getVolume}
* method.
* *
* @return current volume * @return current volume
*/ */
@ -493,7 +495,7 @@ public class UpnpRendererHandler extends UpnpHandler {
/** /**
* Invoke GetVolume on UPnP Rendering Control. * Invoke GetVolume on UPnP Rendering Control.
* Result is received in {@link onValueReceived}. * Result is received in {@link #onValueReceived}.
* *
* @param channel * @param channel
*/ */
@ -534,7 +536,7 @@ public class UpnpRendererHandler extends UpnpHandler {
/** /**
* Invoke getMute on UPnP Rendering Control. * Invoke getMute on UPnP Rendering Control.
* Result is received in {@link onValueReceived}. * Result is received in {@link #onValueReceived}.
* *
* @param channel * @param channel
*/ */
@ -563,7 +565,7 @@ public class UpnpRendererHandler extends UpnpHandler {
/** /**
* Invoke getMute on UPnP Rendering Control. * Invoke getMute on UPnP Rendering Control.
* Result is received in {@link onValueReceived}. * Result is received in {@link #onValueReceived}.
* *
* @param channel * @param channel
*/ */

10
bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/handler/UpnpServerHandler.java
View File

@ -191,7 +191,7 @@ public class UpnpServerHandler extends UpnpHandler {
} }
/** /**
* Method that does a UPnP browse on a content directory. Results will be retrieved in the {@link onValueReceived} * Method that does a UPnP browse on a content directory. Results will be retrieved in the {@link #onValueReceived}
* method. * method.
* *
* @param objectID content directory object * @param objectID content directory object
@ -233,7 +233,7 @@ public class UpnpServerHandler extends UpnpHandler {
} }
/** /**
* Method that does a UPnP search on a content directory. Results will be retrieved in the {@link onValueReceived} * Method that does a UPnP search on a content directory. Results will be retrieved in the {@link #onValueReceived}
* method. * method.
* *
* @param containerID content directory container * @param containerID content directory container
@ -543,7 +543,8 @@ public class UpnpServerHandler extends UpnpHandler {
/** /**
* Add a renderer to the renderer channel state option list. * Add a renderer to the renderer channel state option list.
* This method is called from the {@link UpnpControlHandlerFactory} class when creating a renderer handler. * This method is called from the {@link org.openhab.binding.upnpcontrol.internal.UpnpControlHandlerFactory
* UpnpControlHandlerFactory} class when creating a renderer handler.
* *
* @param key * @param key
*/ */
@ -560,7 +561,8 @@ public class UpnpServerHandler extends UpnpHandler {
/** /**
* Remove a renderer from the renderer channel state option list. * Remove a renderer from the renderer channel state option list.
* This method is called from the {@link UpnpControlHandlerFactory} class when removing a renderer handler. * This method is called from the {@link org.openhab.binding.upnpcontrol.internal.UpnpControlHandlerFactory
* UpnpControlHandlerFactory} class when removing a renderer handler.
* *
* @param key * @param key
*/ */

10
bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/queue/UpnpEntryQueue.java
View File

@ -40,7 +40,7 @@ import com.google.gson.JsonParseException;
* of a current index in the queue. It has convenience methods to play previous/next entries, whereby the queue can be * of a current index in the queue. It has convenience methods to play previous/next entries, whereby the queue can be
* organized to play from first to last (with no repetition), to restart at the start when the end is reached (in a * organized to play from first to last (with no repetition), to restart at the start when the end is reached (in a
* continuous loop), or to random shuffle the entries. Repeat and shuffle are off by default, but can be set using the * continuous loop), or to random shuffle the entries. Repeat and shuffle are off by default, but can be set using the
* {@link setRepeat} and {@link setShuffle} methods. * {@link #setRepeat} and {@link #setShuffle} methods.
* *
* @author Mark Herwege - Initial contribution * @author Mark Herwege - Initial contribution
* *
@ -186,7 +186,7 @@ public class UpnpEntryQueue {
} }
/** /**
* @return the index of the next element in the queue that will be served if {@link next} is called, or -1 if * @return the index of the next element in the queue that will be served if {@link #next} is called, or -1 if
* nothing to serve for next. * nothing to serve for next.
*/ */
public synchronized int nextIndex() { public synchronized int nextIndex() {
@ -198,7 +198,7 @@ public class UpnpEntryQueue {
} }
/** /**
* @return the index of the previous element in the queue that will be served if {@link previous} is called, or -1 * @return the index of the previous element in the queue that will be served if {@link #previous} is called, or -1
* if nothing to serve for next. * if nothing to serve for next.
*/ */
public synchronized int previousIndex() { public synchronized int previousIndex() {
@ -210,7 +210,7 @@ public class UpnpEntryQueue {
} }
/** /**
* @return true if there is an element to server when calling {@link next}. * @return true if there is an element to server when calling {@link #next}.
*/ */
public synchronized boolean hasNext() { public synchronized boolean hasNext() {
int size = currentQueue.size(); int size = currentQueue.size();
@ -221,7 +221,7 @@ public class UpnpEntryQueue {
} }
/** /**
* @return true if there is an element to server when calling {@link previous}. * @return true if there is an element to server when calling {@link #previous}.
*/ */
public synchronized boolean hasPrevious() { public synchronized boolean hasPrevious() {
int size = currentQueue.size(); int size = currentQueue.size();