Package com.attribyte.parser.model

Class Audio

java.lang.Object

com.attribyte.parser.model.Audio

public class Audio
extends Object

An immutable audio stream.

Author:

Matt Hamer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Audio.Builder	Builds an immutable audio stream.

Field Summary

Fields

Modifier and Type	Field	Description
final String	altText	Text that describes the audio, or an empty string if none.
final String	id	A unique id, or an empty string if none.
final String	link	A link to the audio stream.
final String	mediaType	The audio type or an empty string if none.
final String	title	A title for the audio, or an empty string if none.

Method Summary

Modifier and Type	Method	Description
static Audio.Builder	builder(Audio audio)	Creates a builder from an existing audio stream.
static Audio.Builder	builder(String link)	Creates a builder.
boolean	equals(Object o)
int	hashCode()
String	toString()
Audio	withNewLink(String link)	Creates a copy of this audio stream with a new link.
Audio	withNewLink(String link, String mediaType)	Creates a copy of this audio stream with a new link and type.

Methods inherited from class java.lang.Object

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

Field Details

id

public final String id

A unique id, or an empty string if none.

link

public final String link

A link to the audio stream. Never null or empty.

altText

public final String altText

Text that describes the audio, or an empty string if none.

title

public final String title

A title for the audio, or an empty string if none.

mediaType

public final String mediaType

The audio type or an empty string if none.

Method Details

builder

public static Audio.Builder builder(String link)
                             throws UnsupportedOperationException

Creates a builder.

Parameters:

link - The required link.

Returns:

The builder.

Throws:

UnsupportedOperationException - If the specified link is null or empty.

builder

public static Audio.Builder builder(Audio audio)

Creates a builder from an existing audio stream.

Parameters:

audio - The audio.

Returns:

The builder initialized from the existing audio.

withNewLink

public Audio withNewLink(String link)
                  throws UnsupportedOperationException

Creates a copy of this audio stream with a new link.

Parameters:

link - The new link.

Returns:

The new audio.

Throws:

UnsupportedOperationException - If the specified link is null or empty.

withNewLink

public Audio withNewLink(String link,
 String mediaType)
                  throws UnsupportedOperationException

Creates a copy of this audio stream with a new link and type.

Parameters:

link - The new link.

mediaType - The new media type.

Returns:

The new audio.

Throws:

UnsupportedOperationException - If the specified link is null or empty.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object