Media Authoring
with Java API

tv.amwa.maj.enumeration
Enum Boolean

java.lang.Object
  extended by java.lang.Enum<Boolean>
      extended by tv.amwa.maj.enumeration.Boolean
All Implemented Interfaces:
Serializable, Comparable<Boolean>, AAFEnumerationValue

public enum Boolean
extends Enum<Boolean>
implements AAFEnumerationValue

Representation of Boolean values as an enumeration. This enumeration is provided to enable the instantiation of the AAF boolean data type as an enumeration in Java. However, all boolean properties in the MAJ API are actually represented as Java boolean values, often annotated with Bool.

Author:
Richard Cartwright
See Also:
TypeDefinitionEnumeration.Boolean, Bool

Enum Constant Summary
False
           
True
           
 
Method Summary
 long value()
          Returns the unique integer value associated with an enumeration value, either according to the AAF specification and/or the current AAF meta dictionary.
static Boolean valueOf(String name)
          Returns the enum constant of this type with the specified name.
static Boolean[] values()
          Returns an array containing the constants of this enum type, in the order they're 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
 
Methods inherited from interface tv.amwa.maj.enumeration.AAFEnumerationValue
name
 

Enum Constant Detail

False

public static final Boolean False

True

public static final Boolean True
Method Detail

values

public static final Boolean[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(Boolean c : Boolean.values())
        System.out.println(c);

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

valueOf

public static Boolean valueOf(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:
IllegalArgumentException - if this enum type has no constant with the specified name

value

public long value()
Description copied from interface: AAFEnumerationValue

Returns the unique integer value associated with an enumeration value, either according to the AAF specification and/or the current AAF meta dictionary.

Specified by:
value in interface AAFEnumerationValue
Returns:
Unique integer value associated with an enumeration constant.

Media Authoring
with Java API

(c) 2007-2008 Richard Cartwright, all rights reserved. Subject to the terms of the AAF SDK Public Source License.