Package com.attribyte.parser.model

Class Video

java.lang.Object

com.attribyte.parser.model.Video

public class Video
extends Object

An immutable video.

Author:

Matt Hamer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Video.Builder	Builds an immutable video.

Field Summary

Fields

Modifier and Type	Field	Description
final String	altText	Text that describes the video, or an empty string if none.
final Aspect	aspect	The aspect.
final int	bitrate	The video bitrate.
final long	durationMillis	The duration in milliseconds.
final int	height	The video height or 0 if unknown.
final String	id	A unique id, or an empty string if none.
final Image	image	An image representing the video.
final String	link	A link to the video.
final String	mediaType	The video type or an empty string if none.
final String	title	A title for the video, or an empty string if none.
final com.google.common.collect.ImmutableList<Video>	variants	Variants of this video.
final int	width	The video width or 0 if unknown.

Method Summary

Modifier and Type	Method	Description
static Video.Builder	builder(Video video)	Creates a builder from an existing video.
static Video.Builder	builder(String link)	Creates a builder.
boolean	equals(Object o)
int	hashCode()
String	toString()
Video	withNewLink(String link)	Creates a copy of this video with a new link.
Video	withNewLink(String link, String mediaType)	Creates a copy of this video with a new link and media type.
Video	withNewLink(String link, String mediaType, int bitrate)	Creates a copy of this video with a new link, media type and bitreate.
Video	withVariants(Collection<Video> variants)	Creates a copy of this video with variants.

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 video. Never null or empty.

altText

public final String altText

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

title

public final String title

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

width

public final int width

The video width or 0 if unknown.

height

public final int height

The video height or 0 if unknown.

mediaType

public final String mediaType

The video type or an empty string if none.

bitrate

public final int bitrate

The video bitrate.

durationMillis

public final long durationMillis

The duration in milliseconds.

aspect

public final Aspect aspect

The aspect.

image

public final Image image

An image representing the video.

variants

public final com.google.common.collect.ImmutableList<Video> variants

Variants of this video.

Method Details

builder

public static Video.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 Video.Builder builder(Video video)

Creates a builder from an existing video.

Parameters:

video - The video.

Returns:

The builder initialized from the existing video.

withNewLink

public Video withNewLink(String link)
                  throws UnsupportedOperationException

Creates a copy of this video with a new link.

Parameters:

link - The new link.

Returns:

The new video.

Throws:

UnsupportedOperationException - If the specified link is null or empty.

withNewLink

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

Creates a copy of this video with a new link and media type.

Parameters:

link - The new link.

mediaType - The new media type.

Returns:

The new video.

Throws:

UnsupportedOperationException - If the specified link is null or empty.

withNewLink

public Video withNewLink(String link,
 String mediaType,
 int bitrate)
                  throws UnsupportedOperationException

Creates a copy of this video with a new link, media type and bitreate.

Parameters:

link - The new link.

mediaType - The new media type.

bitrate - The new bitrate.

Returns:

The new video.

Throws:

UnsupportedOperationException - If the specified link is null or empty.

withVariants

public Video withVariants(Collection<Video> variants)

Creates a copy of this video with variants.

Parameters:

variants - The variants.

Returns:

The new video.

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