org.jmythapi.protocol.response
Enum ISleepStatus.Flags

java.lang.Object
  java.lang.Enum<ISleepStatus.Flags>
      org.jmythapi.protocol.response.ISleepStatus.Flags

All Implemented Interfaces:

Serializable, Comparable<ISleepStatus.Flags>, IFlag

Enclosing interface:

ISleepStatus

public static enum ISleepStatus.Flags
extends Enum<ISleepStatus.Flags>
implements IFlag

The flags of an ISleepStatus response.

The following list contains all possible awake/sleep states of a MythTV backend slave.

MythTV Protocol Version Matrix
		Protocol
Name	Type	Range	45	-1
SSTATUS_AWAKE	IFlag	[45,-1)	X	X
SSTATUS_ASLEEP	IFlag	[45,-1)	X	X
SSTATUS_FALLING_ASLEEP	IFlag	[45,-1)	X	X
SSTATUS_WAKING	IFlag	[45,-1)	X	X
SSTATUS_UNDEFINED	IFlag	[45,-1)	X	X

Since:

45

See Also:

tv.h

Enum Constant Summary

SSTATUS_ASLEEP
Asleep.

SSTATUS_AWAKE
Awaken.

SSTATUS_FALLING_ASLEEP
Falling asleep.

SSTATUS_UNDEFINED
Undefined.

SSTATUS_WAKING
Waking.

Method Summary

Long	getFlagValue() Gets the value associated with the flag.
static ISleepStatus.Flags	valueOf(String name) Returns the enum constant of this type with the specified name.
static ISleepStatus.Flags[]	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

Methods inherited from interface org.jmythapi.protocol.response.IFlag

name

Enum Constant Detail

SSTATUS_AWAKE

public static final ISleepStatus.Flags SSTATUS_AWAKE

Awaken.

A slave is awake when it is connected to the master

SSTATUS_ASLEEP

public static final ISleepStatus.Flags SSTATUS_ASLEEP

Asleep.

A slave is considered asleep when it is not awake and not undefined.

SSTATUS_FALLING_ASLEEP

public static final ISleepStatus.Flags SSTATUS_FALLING_ASLEEP

Falling asleep.

A slave is marked as falling asleep when told to shutdown by the master.

SSTATUS_WAKING

public static final ISleepStatus.Flags SSTATUS_WAKING

Waking.

A slave is marked as waking when the master runs the slave's wakeup command

SSTATUS_UNDEFINED

public static final ISleepStatus.Flags SSTATUS_UNDEFINED

Undefined.

A slave's sleep status is undefined when it has never connected to the master backend or is not able to be put to sleep and awakened.

Method Detail

values

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

Returns:

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

valueOf

public static ISleepStatus.Flags 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

NullPointerException - if the argument is null

getFlagValue

public Long getFlagValue()

Description copied from interface: IFlag

Gets the value associated with the flag.

Specified by:

getFlagValue in interface IFlag

Returns:

the flag value