org.opencastproject.mediapackage

Class MediaPackageElementFlavor

java.lang.Object

org.opencastproject.mediapackage.MediaPackageElementFlavor

All Implemented Interfaces:

Serializable, Cloneable, Comparable<MediaPackageElementFlavor>

public class MediaPackageElementFlavor
extends Object
implements Cloneable, Comparable<MediaPackageElementFlavor>, Serializable

ELement flavors describe MediaPackageElements in a semantic way. They reveal or give at least a hint about the meaning of an element.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Function<String,MediaPackageElementFlavor>	parseFlavor
static String	WILDCARD Wildcard character used in type and subtype

Constructor Summary

Constructors

Constructor and Description
MediaPackageElementFlavor(String type, String subtype) Creates a new flavor with the given type and subtype.

Method Summary

Modifier and Type	Method and Description
MediaPackageElementFlavor	applyTo(MediaPackageElementFlavor target) "Applies" this flavor to the given target flavor.
MediaPackageElementFlavor	clone()
int	compareTo(MediaPackageElementFlavor m)
boolean	eq(String flavor) Defines equality between flavors and strings.
boolean	equals(Object other)
static MediaPackageElementFlavor	flavor(String type, String subtype) Constructor function for MediaPackageElementFlavor(String, String).
String	getSubtype() Returns the subtype of this flavor.
String	getType() Returns the type of this flavor.
int	hashCode()
boolean	matches(MediaPackageElementFlavor other) Check if two flavors match.
static MediaPackageElementFlavor	parseFlavor(String s) Creates a new media package element flavor.
String	toString() Returns the flavor as a string "type/subtype".

Methods inherited from class java.lang.Object

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

Field Detail

WILDCARD

public static final String WILDCARD

Wildcard character used in type and subtype

See Also:

Constant Field Values

parseFlavor

public static final Function<String,MediaPackageElementFlavor> parseFlavor

Constructor Detail

MediaPackageElementFlavor

public MediaPackageElementFlavor(String type,
                                 String subtype)

Creates a new flavor with the given type and subtype.

Parameters:

type - the type of the flavor

subtype - the subtype of the flavor

Method Detail

flavor

public static MediaPackageElementFlavor flavor(String type,
                                               String subtype)

Constructor function for MediaPackageElementFlavor(String, String).

getType

public String getType()

Returns the type of this flavor. The type is never null.

For example, if the type is a presentation movie which is represented as presentation/source, this method will return presentation.

Returns:

the type of this flavor

getSubtype

public String getSubtype()

Returns the subtype of this flavor. The subtype is never null.

For example, if the subtype is a presentation movie which is represented as presentation/source, this method will return source.

Returns:

the subtype

applyTo

public MediaPackageElementFlavor applyTo(MediaPackageElementFlavor target)

"Applies" this flavor to the given target flavor. E.g. applying '*\/preview' to 'presenter/source' yields 'presenter/preview', applying 'presenter/*' to 'foo/source' yields 'presenter/source', and applying 'foo/bar' to 'presenter/source' yields 'foo/bar'.

Parameters:

target - The target flavor to apply this flavor to.

Returns:

The resulting flavor.

clone

public MediaPackageElementFlavor clone()
                                throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

See Also:

Object.clone()

eq

public boolean eq(String flavor)

Defines equality between flavors and strings.

Parameters:

flavor - string of the form "type/subtype"

compareTo

public int compareTo(MediaPackageElementFlavor m)

Specified by:

compareTo in interface Comparable<MediaPackageElementFlavor>

See Also:

String.compareTo(java.lang.Object)

toString

public String toString()

Returns the flavor as a string "type/subtype".

Overrides:

toString in class Object

parseFlavor

public static MediaPackageElementFlavor parseFlavor(String s)
                                             throws IllegalArgumentException

Creates a new media package element flavor.

Parameters:

s - the media package flavor

Returns:

the media package element flavor object

Throws:

IllegalArgumentException - if the string s does not contain a dash to divide the type from subtype.

matches

public boolean matches(MediaPackageElementFlavor other)

Check if two flavors match. Two flavors match if both their type and subtype matches.

Parameters:

other - Flavor to compare against

Returns:

If the flavors match

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object