org.asteriskjava.live
Enum ChannelState

java.lang.Object
  java.lang.Enum<ChannelState>
      org.asteriskjava.live.ChannelState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ChannelState>

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

The lifecycle status of an AsteriskChannel.

Version:

$Id: ChannelState.java 349 2006-05-22 17:47:00Z srt $

Author:

srt

Enum Constant Summary

BUSY

DIALING

DOWN
The initial state of the channel when it is not yet in use.

HUNGUP
The channel has been hung up.

OFF_HOOK

RING

RINGING

RSRVD

UP

Method Summary

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

DOWN

public static final ChannelState DOWN

The initial state of the channel when it is not yet in use.

OFF_HOOK

public static final ChannelState OFF_HOOK

DIALING

public static final ChannelState DIALING

RING

public static final ChannelState RING

RINGING

public static final ChannelState RINGING

UP

public static final ChannelState UP

BUSY

public static final ChannelState BUSY

RSRVD

public static final ChannelState RSRVD

HUNGUP

public static final ChannelState HUNGUP

The channel has been hung up.

Method Detail

values

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

Returns:

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

valueOf

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