diff --git a/bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/audiosink/UpnpAudioSinkReg.java b/bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/audiosink/UpnpAudioSinkReg.java index 8c8d959c32c..734551a307e 100644 --- a/bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/audiosink/UpnpAudioSinkReg.java +++ b/bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/audiosink/UpnpAudioSinkReg.java @@ -16,9 +16,9 @@ import org.eclipse.jdt.annotation.NonNullByDefault; import org.openhab.binding.upnpcontrol.internal.handler.UpnpRendererHandler; /** - * Interface class to be implemented in {@link UpnpControlHandlerFactory}, allows a {UpnpRendererHandler} to register - * itself as an audio sink when it supports audio. If it supports audio is only known after the communication with the - * renderer is established. + * Interface class to be implemented in {@link org.openhab.binding.upnpcontrol.internal.UpnpControlHandlerFactory + * UpnpControlHandlerFactory}, allows a {@link UpnpRendererHandler} to register itself as an audio sink when it supports + * audio. If it supports audio is only known after the communication with the renderer is established. * * @author Mark Herwege - Initial contribution */ diff --git a/bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/handler/UpnpHandler.java b/bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/handler/UpnpHandler.java index 5fc8b04041f..b22baa73d66 100644 --- a/bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/handler/UpnpHandler.java +++ b/bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/handler/UpnpHandler.java @@ -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 - * {@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 */ @@ -292,7 +293,7 @@ public abstract class UpnpHandler extends BaseThingHandler implements UpnpIOPart /** * Invoke PrepareForConnection on the UPnP Connection Manager. - * Result is received in {@link onValueReceived}. + * Result is received in {@link #onValueReceived}. * * @param remoteProtocolInfo * @param peerConnectionManager @@ -339,7 +340,7 @@ public abstract class UpnpHandler extends BaseThingHandler implements UpnpIOPart /** * Invoke GetCurrentConnectionIDs on the UPnP Connection Manager. - * Result is received in {@link onValueReceived}. + * Result is received in {@link #onValueReceived}. */ protected void getCurrentConnectionIDs() { Map inputs = Collections.emptyMap(); @@ -349,7 +350,7 @@ public abstract class UpnpHandler extends BaseThingHandler implements UpnpIOPart /** * Invoke GetCurrentConnectionInfo on the UPnP Connection Manager. - * Result is received in {@link onValueReceived}. + * Result is received in {@link #onValueReceived}. */ protected void getCurrentConnectionInfo() { CompletableFuture settingAVTransport = isAvTransportIdSet; @@ -373,7 +374,7 @@ public abstract class UpnpHandler extends BaseThingHandler implements UpnpIOPart /** * Invoke GetFeatureList on the UPnP Connection Manager. - * Result is received in {@link onValueReceived}. + * Result is received in {@link #onValueReceived}. */ protected void getFeatureList() { Map inputs = Collections.emptyMap(); @@ -383,7 +384,7 @@ public abstract class UpnpHandler extends BaseThingHandler implements UpnpIOPart /** * Invoke GetProtocolInfo on UPnP Connection Manager. - * Result is received in {@link onValueReceived}. + * Result is received in {@link #onValueReceived}. */ protected void getProtocolInfo() { Map 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 - * submits the call and calls {@link onValueReceived} upon completion. All state updates or other actions depending - * on the results should be triggered from {@link onValueReceived} because the class fields with results will be - * filled asynchronously. + * This method wraps {@link org.openhab.core.io.transport.upnp.UpnpIOService#invokeAction invokeAction}. It + * schedules and submits the call and calls {@link #onValueReceived} upon completion. All state updates or other + * actions depending on the results should be triggered from {@link #onValueReceived} because the class fields with + * results will be filled asynchronously. * * @param serviceId * @param actionId diff --git a/bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/handler/UpnpRendererHandler.java b/bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/handler/UpnpRendererHandler.java index 9449ca66646..41fc8e8f9c1 100644 --- a/bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/handler/UpnpRendererHandler.java +++ b/bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/handler/UpnpRendererHandler.java @@ -453,7 +453,7 @@ public class UpnpRendererHandler extends UpnpHandler { /** * Invoke GetTransportState on UPnP AV Transport. - * Result is received in {@link onValueReceived}. + * Result is received in {@link #onValueReceived}. */ protected void getTransportState() { Map inputs = Collections.singletonMap(INSTANCE_ID, Integer.toString(avTransportId)); @@ -463,7 +463,7 @@ public class UpnpRendererHandler extends UpnpHandler { /** * Invoke getPositionInfo on UPnP AV Transport. - * Result is received in {@link onValueReceived}. + * Result is received in {@link #onValueReceived}. */ protected void getPositionInfo() { Map inputs = Collections.singletonMap(INSTANCE_ID, Integer.toString(avTransportId)); @@ -473,7 +473,7 @@ public class UpnpRendererHandler extends UpnpHandler { /** * Invoke GetMediaInfo on UPnP AV Transport. - * Result is received in {@link onValueReceived}. + * Result is received in {@link #onValueReceived}. */ protected void getMediaInfo() { Map 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 - * 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 */ @@ -493,7 +495,7 @@ public class UpnpRendererHandler extends UpnpHandler { /** * Invoke GetVolume on UPnP Rendering Control. - * Result is received in {@link onValueReceived}. + * Result is received in {@link #onValueReceived}. * * @param channel */ @@ -534,7 +536,7 @@ public class UpnpRendererHandler extends UpnpHandler { /** * Invoke getMute on UPnP Rendering Control. - * Result is received in {@link onValueReceived}. + * Result is received in {@link #onValueReceived}. * * @param channel */ @@ -563,7 +565,7 @@ public class UpnpRendererHandler extends UpnpHandler { /** * Invoke getMute on UPnP Rendering Control. - * Result is received in {@link onValueReceived}. + * Result is received in {@link #onValueReceived}. * * @param channel */ diff --git a/bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/handler/UpnpServerHandler.java b/bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/handler/UpnpServerHandler.java index b5970c12084..8355367f0eb 100644 --- a/bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/handler/UpnpServerHandler.java +++ b/bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/handler/UpnpServerHandler.java @@ -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. * * @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. * * @param containerID content directory container @@ -543,7 +543,8 @@ public class UpnpServerHandler extends UpnpHandler { /** * 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 */ @@ -560,7 +561,8 @@ public class UpnpServerHandler extends UpnpHandler { /** * 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 */ diff --git a/bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/queue/UpnpEntryQueue.java b/bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/queue/UpnpEntryQueue.java index 1e89ff795ae..2efbed0c0c0 100644 --- a/bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/queue/UpnpEntryQueue.java +++ b/bundles/org.openhab.binding.upnpcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/queue/UpnpEntryQueue.java @@ -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 * 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 - * {@link setRepeat} and {@link setShuffle} methods. + * {@link #setRepeat} and {@link #setShuffle} methods. * * @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. */ 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. */ 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() { 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() { int size = currentQueue.size();