service.tut.pori.subtitles

Enum SubtitlesCore.SubtitleFormat

java.lang.Object

java.lang.Enum<SubtitlesCore.SubtitleFormat>

service.tut.pori.subtitles.SubtitlesCore.SubtitleFormat

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SubtitlesCore.SubtitleFormat>

Enclosing class:

SubtitlesCore

public static enum SubtitlesCore.SubtitleFormat
extends java.lang.Enum<SubtitlesCore.SubtitleFormat>

Formatting option for media objects in a subtitle

Enum Constant Summary

Enum Constants

Enum Constant and Description
GROUPED media objects will appear grouped by timecodes, combined in a single line An example in WEBVTT format:
INDIVIDUAL media objects will appear in individual lines, with one timecode sequence per media object An example in WEBVTT format:

Method Summary

Modifier and Type	Method and Description
static SubtitlesCore.SubtitleFormat	fromFormatString(java.lang.String value)
java.lang.String	toFormatString()
static SubtitlesCore.SubtitleFormat	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SubtitlesCore.SubtitleFormat[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GROUPED

public static final SubtitlesCore.SubtitleFormat GROUPED

media objects will appear grouped by timecodes, combined in a single line An example in WEBVTT format:

 00:44.000 --> 01:19.000
 Keyword1, Keyword2

 01:24.000 --> 05:00.000
 Keyword1, Keyword3
 

INDIVIDUAL

public static final SubtitlesCore.SubtitleFormat INDIVIDUAL

media objects will appear in individual lines, with one timecode sequence per media object An example in WEBVTT format:

 00:44.000 --> 01:19.000
 Keyword1

 00:44.000 --> 01:19.000
 Keyword2

 01:24.000 --> 05:00.000
 Keyword1
 
 01:24.000 --> 05:00.000
 Keyword3
 

Method Detail

values

public static SubtitlesCore.SubtitleFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SubtitlesCore.SubtitleFormat c : SubtitlesCore.SubtitleFormat.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SubtitlesCore.SubtitleFormat valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

fromFormatString

public static SubtitlesCore.SubtitleFormat fromFormatString(java.lang.String value)
                                                     throws java.lang.IllegalArgumentException

Parameters:

value -

Returns:

value converted to SubtitleFormat

Throws:

java.lang.IllegalArgumentException - on bad value

toFormatString

public java.lang.String toFormatString()

Returns:

the formatting option as a string