Refactored getMediaStatus() to return a list of MediaStatus instances instead of only the first instance

Author: Nadahar

src/main/java/org/digitalmediaserver/cast/Channel.java

@@ -29,6 +29,7 @@
 import java.security.KeyManagementException;
 import java.security.NoSuchAlgorithmException;
 import java.security.SecureRandom;
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Iterator;
@@ -961,38 +962,38 @@ public boolean isSessionClosed(@Nullable Session session) {
 	}
 
 	/**
-	 * Request a {@link MediaStatus} from the application with the specified
-	 * {@link Session}, using {@value #DEFAULT_RESPONSE_TIMEOUT} as the timeout
-	 * value.
+	 * Request a list of {@link MediaStatus}es from the application with the
+	 * specified {@link Session}, using {@value #DEFAULT_RESPONSE_TIMEOUT} as
+	 * the timeout value.
 	 *
 	 * @param session the {@link Session} to use.
-	 * @return The resulting {@link MediaStatus}.
+	 * @return The resulting {@link List} of {@link MediaStatus}.
 	 * @throws IOException If the response times out or an error occurs during
 	 *             the operation.
 	 *
 	 * @apiNote This operation is blocking.
 	 */
-	@Nullable
-	public MediaStatus getMediaStatus(@Nonnull Session session) throws IOException {
+	@Nonnull
+	public List<MediaStatus> getMediaStatus(@Nonnull Session session) throws IOException {
 		return getMediaStatus(session, DEFAULT_RESPONSE_TIMEOUT);
 	}
 
 	/**
-	 * Request a {@link MediaStatus} from the application with the specified
-	 * {@link Session}.
+	 * Request a list of {@link MediaStatus}es from the application with the
+	 * specified {@link Session}.
 	 *
 	 * @param session the {@link Session} to use.
 	 * @param responseTimeout the response timeout in milliseconds. If zero or
 	 *            negative, {@value #DEFAULT_RESPONSE_TIMEOUT} will be used.
-	 * @return The resulting {@link MediaStatus}.
+	 * @return The resulting {@link List} of {@link MediaStatus}.
 	 * @throws IllegalArgumentException If {@code session} is {@code null}.
 	 * @throws IOException If the response times out or an error occurs during
 	 *             the operation.
 	 *
 	 * @apiNote This operation is blocking.
 	 */
-	@Nullable
-	public MediaStatus getMediaStatus(@Nonnull Session session, long responseTimeout) throws IOException {
+	@Nonnull
+	public List<MediaStatus> getMediaStatus(@Nonnull Session session, long responseTimeout) throws IOException {
 		requireNotNull(session, "session");
 		MediaStatusResponse status = send(
 			session,
@@ -1003,7 +1004,10 @@ public MediaStatus getMediaStatus(@Nonnull Session session, long responseTimeout
 			MediaStatusResponse.class,
 			responseTimeout
 		);
-		return status == null || status.getStatuses().isEmpty() ? null : status.getStatuses().get(0);
+		if (status == null) {
+			return Collections.emptyList();
+		}
+		return status.getStatuses();
 	}
 
 	/**

src/main/java/org/digitalmediaserver/cast/Session.java

@@ -941,25 +941,25 @@ public MediaStatus setVolume(
 	}
 
 	/**
-	 * Requests an updated {@link MediaStatus} from the remote application. This
+	 * Requests a list of updated {@link MediaStatus}es from the remote application. This
 	 * method is always blocking.
 	 * <p>
 	 * This can only succeed if the remote application supports the
 	 * {@link CastDevice#CAST_MEDIA_NAMESPACE}.
 	 *
-	 * @return The resulting {@link MediaStatus} if a reply is received in time,
-	 *         or {@code null} if a timeout occurs.
-	 * @throws IOException If an error occurs during the operation.
+	 * @return The resulting {@link List} of {@link MediaStatus}.
+	 * @throws IOException If the response times out or an error occurs during
+	 *             the operation.
 	 *
 	 * @apiNote This operation is blocking.
 	 */
-	@Nullable
-	public MediaStatus getMediaStatus() throws IOException {
+	@Nonnull
+	public List<MediaStatus> getMediaStatus() throws IOException {
 		return channel.getMediaStatus(this);
 	}
 
 	/**
-	 * Requests an updated {@link MediaStatus} from the remote application. This
+	 * Requests a list of updated {@link MediaStatus}es from the remote application. This
 	 * method is always blocking.
 	 * <p>
 	 * This can only succeed if the remote application supports the
@@ -968,14 +968,14 @@ public MediaStatus getMediaStatus() throws IOException {
 	 * @param responseTimeout the response timeout in milliseconds. If zero or
 	 *            negative, {@link Channel#DEFAULT_RESPONSE_TIMEOUT} will be
 	 *            used.
-	 * @return The resulting {@link MediaStatus} if a reply is received in time,
-	 *         or {@code null} if a timeout occurs.
-	 * @throws IOException If an error occurs during the operation.
+	 * @return The resulting {@link List} of {@link MediaStatus}.
+	 * @throws IOException If the response times out or an error occurs during
+	 *             the operation.
 	 *
 	 * @apiNote This operation is blocking.
 	 */
-	@Nullable
-	public MediaStatus getMediaStatus(long responseTimeout) throws IOException {
+	@Nonnull
+	public List<MediaStatus> getMediaStatus(long responseTimeout) throws IOException {
 		return channel.getMediaStatus(this, responseTimeout);
 	}