org.stanwood.media.model
Enum Mode

java.lang.Object
  extended by java.lang.Enum<Mode>
      extended by org.stanwood.media.model.Mode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Mode>

public enum Mode
extends java.lang.Enum<Mode>

This enumeration contains the rename modes


Enum Constant Summary
FILM
          When using FILM mode files are treated as films
TV_SHOW
          When using TV_SHOW mode files are treated as tv show episodes
 
Method Summary
 java.lang.String getDisplayName()
          Used to get the display name of the mode
static java.lang.String modeList()
          Get a list of modes
static Mode valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Mode[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

FILM

public static final Mode FILM
When using FILM mode files are treated as films


TV_SHOW

public static final Mode TV_SHOW
When using TV_SHOW mode files are treated as tv show episodes

Method Detail

values

public static Mode[] 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 (Mode c : Mode.values())
    System.out.println(c);

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

valueOf

public static Mode 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

getDisplayName

public java.lang.String getDisplayName()
Used to get the display name of the mode

Returns:
The display name

modeList

public static java.lang.String modeList()
Get a list of modes

Returns:
The list of modes