org.jaudiotagger.audio.ogg.util
Enum OggPageHeader.HeaderTypeFlag

java.lang.Object
  java.lang.Enum<OggPageHeader.HeaderTypeFlag>
      org.jaudiotagger.audio.ogg.util.OggPageHeader.HeaderTypeFlag

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OggPageHeader.HeaderTypeFlag>

Enclosing class:

OggPageHeader

public static enum OggPageHeader.HeaderTypeFlag
extends java.lang.Enum<OggPageHeader.HeaderTypeFlag>

This represents all the flags that can be set in the headerType field. Note these values can be ORED together. For example the last packet in a file would normally have a value of 0x5 because both the CONTINUED_PACKET bit and the END_OF_BITSTREAM bit would be set.

Enum Constant Summary

CONTINUED_PACKET

END_OF_BITSTREAM

FRESH_PACKET

START_OF_BITSTREAM

Field Summary

(package private) byte

fileValue

Method Summary

byte	getFileValue()
static OggPageHeader.HeaderTypeFlag	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OggPageHeader.HeaderTypeFlag[]	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

FRESH_PACKET

public static final OggPageHeader.HeaderTypeFlag FRESH_PACKET

CONTINUED_PACKET

public static final OggPageHeader.HeaderTypeFlag CONTINUED_PACKET

START_OF_BITSTREAM

public static final OggPageHeader.HeaderTypeFlag START_OF_BITSTREAM

END_OF_BITSTREAM

public static final OggPageHeader.HeaderTypeFlag END_OF_BITSTREAM

Field Detail

fileValue

byte fileValue

Method Detail

values

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

Returns:

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

valueOf

public static OggPageHeader.HeaderTypeFlag 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

getFileValue

public byte getFileValue()

Returns:

the value that should be written to file to enable this flag