Package org.openhab.core.audio

Record Class StreamServed

java.lang.Object

java.lang.Record

org.openhab.core.audio.StreamServed

@NonNullByDefault
public record StreamServed(String url, AudioStream audioStream, AtomicInteger currentlyServedStream, AtomicLong timeout, boolean multiTimeStream, CompletableFuture<@Nullable Void> playEnd)
extends Record

Streams served by the AudioHTTPServer.

Author:

Gwendal Roulleau - Initial contribution

Constructor Summary

Constructors

Constructor	Description
StreamServed(String url, AudioStream audioStream, AtomicInteger currentlyServedStream, AtomicLong timeout, boolean multiTimeStream, CompletableFuture<@Nullable Void> playEnd)	Creates an instance of a StreamServed record class.

Method Summary

Modifier and Type	Method	Description
AudioStream	audioStream()	Returns the value of the audioStream record component.
AtomicInteger	currentlyServedStream()	Returns the value of the currentlyServedStream record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	multiTimeStream()	Returns the value of the multiTimeStream record component.
CompletableFuture<@Nullable Void>	playEnd()	Returns the value of the playEnd record component.
AtomicLong	timeout()	Returns the value of the timeout record component.
final String	toString()	Returns a string representation of this record class.
String	url()	Returns the value of the url record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

StreamServed

public StreamServed(String url,
 AudioStream audioStream,
 AtomicInteger currentlyServedStream,
 AtomicLong timeout,
 boolean multiTimeStream,
 CompletableFuture<@Nullable Void> playEnd)

Creates an instance of a StreamServed record class.

Parameters:

url - the value for the url record component

audioStream - the value for the audioStream record component

currentlyServedStream - the value for the currentlyServedStream record component

timeout - the value for the timeout record component

multiTimeStream - the value for the multiTimeStream record component

playEnd - the value for the playEnd record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

url

public String url()

Returns the value of the url record component.

Returns:

the value of the url record component

audioStream

public AudioStream audioStream()

Returns the value of the audioStream record component.

Returns:

the value of the audioStream record component

currentlyServedStream

public AtomicInteger currentlyServedStream()

Returns the value of the currentlyServedStream record component.

Returns:

the value of the currentlyServedStream record component

timeout

public AtomicLong timeout()

Returns the value of the timeout record component.

Returns:

the value of the timeout record component

multiTimeStream

public boolean multiTimeStream()

Returns the value of the multiTimeStream record component.

Returns:

the value of the multiTimeStream record component

playEnd

public CompletableFuture<@Nullable Void> playEnd()

Returns the value of the playEnd record component.

Returns:

the value of the playEnd record component