Asterisk-Java

org.asteriskjava.live
Enum HangupCause

java.lang.Object
  extended by java.lang.Enum<HangupCause>
      extended by org.asteriskjava.live.HangupCause
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<HangupCause>

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

Asterisk hangup cause.

Definitions from /include/asterisk/causes.h.

Version:
$Id: HangupCause.java 962 2008-02-03 03:34:11Z srt $
Author:
srt

Enum Constant Summary
AST_CAUSE_ACCESS_INFO_DISCARDED
           
AST_CAUSE_BEARERCAPABILITY_NOTAUTH
           
AST_CAUSE_BEARERCAPABILITY_NOTAVAIL
           
AST_CAUSE_BEARERCAPABILITY_NOTIMPL
           
AST_CAUSE_BUSY
           
AST_CAUSE_CALL_AWARDED_DELIVERED
           
AST_CAUSE_CALL_REJECTED
           
AST_CAUSE_CHAN_NOT_IMPLEMENTED
           
AST_CAUSE_CHANNEL_UNACCEPTABLE
           
AST_CAUSE_CONGESTION
           
AST_CAUSE_DESTINATION_OUT_OF_ORDER
           
AST_CAUSE_FACILITY_NOT_IMPLEMENTED
           
AST_CAUSE_FACILITY_NOT_SUBSCRIBED
           
AST_CAUSE_FACILITY_REJECTED
           
AST_CAUSE_FAILURE
           
AST_CAUSE_IE_NONEXIST
           
AST_CAUSE_INCOMING_CALL_BARRED
           
AST_CAUSE_INCOMPATIBLE_DESTINATION
           
AST_CAUSE_INTERWORKING
           
AST_CAUSE_INVALID_CALL_REFERENCE
           
AST_CAUSE_INVALID_IE_CONTENTS
           
AST_CAUSE_INVALID_MSG_UNSPECIFIED
           
AST_CAUSE_INVALID_NUMBER_FORMAT
           
AST_CAUSE_MANDATORY_IE_LENGTH_ERROR
           
AST_CAUSE_MANDATORY_IE_MISSING
           
AST_CAUSE_MESSAGE_TYPE_NONEXIST
           
AST_CAUSE_NETWORK_OUT_OF_ORDER
           
AST_CAUSE_NO_ANSWER
           
AST_CAUSE_NO_ROUTE_DESTINATION
           
AST_CAUSE_NO_ROUTE_TRANSIT_NET
           
AST_CAUSE_NO_USER_RESPONSE
           
AST_CAUSE_NOANSWER
           
AST_CAUSE_NORMAL
           
AST_CAUSE_NORMAL_CIRCUIT_CONGESTION
           
AST_CAUSE_NORMAL_CLEARING
           
AST_CAUSE_NORMAL_TEMPORARY_FAILURE
           
AST_CAUSE_NORMAL_UNSPECIFIED
           
AST_CAUSE_NOSUCHDRIVER
           
AST_CAUSE_NOTDEFINED
           
AST_CAUSE_NUMBER_CHANGED
           
AST_CAUSE_OUTGOING_CALL_BARRED
           
AST_CAUSE_PRE_EMPTED
           
AST_CAUSE_PROTOCOL_ERROR
           
AST_CAUSE_RECOVERY_ON_TIMER_EXPIRE
           
AST_CAUSE_REQUESTED_CHAN_UNAVAIL
           
AST_CAUSE_RESPONSE_TO_STATUS_ENQUIRY
           
AST_CAUSE_SWITCH_CONGESTION
           
AST_CAUSE_UNALLOCATED
           
AST_CAUSE_UNREGISTERED
           
AST_CAUSE_USER_BUSY
           
AST_CAUSE_WRONG_CALL_STATE
           
AST_CAUSE_WRONG_MESSAGE
           
 
Method Summary
static HangupCause getByCode(int code)
          Returns the HangupCode by its numeric cause code.
 int getCode()
          Returns the numeric cause code.
 java.lang.String toString()
           
static HangupCause valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static HangupCause[] 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, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

AST_CAUSE_UNALLOCATED

public static final HangupCause AST_CAUSE_UNALLOCATED

AST_CAUSE_NO_ROUTE_TRANSIT_NET

public static final HangupCause AST_CAUSE_NO_ROUTE_TRANSIT_NET

AST_CAUSE_NO_ROUTE_DESTINATION

public static final HangupCause AST_CAUSE_NO_ROUTE_DESTINATION

AST_CAUSE_CHANNEL_UNACCEPTABLE

public static final HangupCause AST_CAUSE_CHANNEL_UNACCEPTABLE

AST_CAUSE_CALL_AWARDED_DELIVERED

public static final HangupCause AST_CAUSE_CALL_AWARDED_DELIVERED

AST_CAUSE_NORMAL_CLEARING

public static final HangupCause AST_CAUSE_NORMAL_CLEARING

AST_CAUSE_USER_BUSY

public static final HangupCause AST_CAUSE_USER_BUSY

AST_CAUSE_NO_USER_RESPONSE

public static final HangupCause AST_CAUSE_NO_USER_RESPONSE

AST_CAUSE_NO_ANSWER

public static final HangupCause AST_CAUSE_NO_ANSWER

AST_CAUSE_CALL_REJECTED

public static final HangupCause AST_CAUSE_CALL_REJECTED

AST_CAUSE_NUMBER_CHANGED

public static final HangupCause AST_CAUSE_NUMBER_CHANGED

AST_CAUSE_DESTINATION_OUT_OF_ORDER

public static final HangupCause AST_CAUSE_DESTINATION_OUT_OF_ORDER

AST_CAUSE_INVALID_NUMBER_FORMAT

public static final HangupCause AST_CAUSE_INVALID_NUMBER_FORMAT

AST_CAUSE_FACILITY_REJECTED

public static final HangupCause AST_CAUSE_FACILITY_REJECTED

AST_CAUSE_RESPONSE_TO_STATUS_ENQUIRY

public static final HangupCause AST_CAUSE_RESPONSE_TO_STATUS_ENQUIRY

AST_CAUSE_NORMAL_UNSPECIFIED

public static final HangupCause AST_CAUSE_NORMAL_UNSPECIFIED

AST_CAUSE_NORMAL_CIRCUIT_CONGESTION

public static final HangupCause AST_CAUSE_NORMAL_CIRCUIT_CONGESTION

AST_CAUSE_NETWORK_OUT_OF_ORDER

public static final HangupCause AST_CAUSE_NETWORK_OUT_OF_ORDER

AST_CAUSE_NORMAL_TEMPORARY_FAILURE

public static final HangupCause AST_CAUSE_NORMAL_TEMPORARY_FAILURE

AST_CAUSE_SWITCH_CONGESTION

public static final HangupCause AST_CAUSE_SWITCH_CONGESTION

AST_CAUSE_ACCESS_INFO_DISCARDED

public static final HangupCause AST_CAUSE_ACCESS_INFO_DISCARDED

AST_CAUSE_REQUESTED_CHAN_UNAVAIL

public static final HangupCause AST_CAUSE_REQUESTED_CHAN_UNAVAIL

AST_CAUSE_PRE_EMPTED

public static final HangupCause AST_CAUSE_PRE_EMPTED

AST_CAUSE_FACILITY_NOT_SUBSCRIBED

public static final HangupCause AST_CAUSE_FACILITY_NOT_SUBSCRIBED

AST_CAUSE_OUTGOING_CALL_BARRED

public static final HangupCause AST_CAUSE_OUTGOING_CALL_BARRED

AST_CAUSE_INCOMING_CALL_BARRED

public static final HangupCause AST_CAUSE_INCOMING_CALL_BARRED

AST_CAUSE_BEARERCAPABILITY_NOTAUTH

public static final HangupCause AST_CAUSE_BEARERCAPABILITY_NOTAUTH

AST_CAUSE_BEARERCAPABILITY_NOTAVAIL

public static final HangupCause AST_CAUSE_BEARERCAPABILITY_NOTAVAIL

AST_CAUSE_BEARERCAPABILITY_NOTIMPL

public static final HangupCause AST_CAUSE_BEARERCAPABILITY_NOTIMPL

AST_CAUSE_CHAN_NOT_IMPLEMENTED

public static final HangupCause AST_CAUSE_CHAN_NOT_IMPLEMENTED

AST_CAUSE_FACILITY_NOT_IMPLEMENTED

public static final HangupCause AST_CAUSE_FACILITY_NOT_IMPLEMENTED

AST_CAUSE_INVALID_CALL_REFERENCE

public static final HangupCause AST_CAUSE_INVALID_CALL_REFERENCE

AST_CAUSE_INCOMPATIBLE_DESTINATION

public static final HangupCause AST_CAUSE_INCOMPATIBLE_DESTINATION

AST_CAUSE_INVALID_MSG_UNSPECIFIED

public static final HangupCause AST_CAUSE_INVALID_MSG_UNSPECIFIED

AST_CAUSE_MANDATORY_IE_MISSING

public static final HangupCause AST_CAUSE_MANDATORY_IE_MISSING

AST_CAUSE_MESSAGE_TYPE_NONEXIST

public static final HangupCause AST_CAUSE_MESSAGE_TYPE_NONEXIST

AST_CAUSE_WRONG_MESSAGE

public static final HangupCause AST_CAUSE_WRONG_MESSAGE

AST_CAUSE_IE_NONEXIST

public static final HangupCause AST_CAUSE_IE_NONEXIST

AST_CAUSE_INVALID_IE_CONTENTS

public static final HangupCause AST_CAUSE_INVALID_IE_CONTENTS

AST_CAUSE_WRONG_CALL_STATE

public static final HangupCause AST_CAUSE_WRONG_CALL_STATE

AST_CAUSE_RECOVERY_ON_TIMER_EXPIRE

public static final HangupCause AST_CAUSE_RECOVERY_ON_TIMER_EXPIRE

AST_CAUSE_MANDATORY_IE_LENGTH_ERROR

public static final HangupCause AST_CAUSE_MANDATORY_IE_LENGTH_ERROR

AST_CAUSE_PROTOCOL_ERROR

public static final HangupCause AST_CAUSE_PROTOCOL_ERROR

AST_CAUSE_INTERWORKING

public static final HangupCause AST_CAUSE_INTERWORKING

AST_CAUSE_BUSY

public static final HangupCause AST_CAUSE_BUSY

AST_CAUSE_FAILURE

public static final HangupCause AST_CAUSE_FAILURE

AST_CAUSE_NORMAL

public static final HangupCause AST_CAUSE_NORMAL

AST_CAUSE_NOANSWER

public static final HangupCause AST_CAUSE_NOANSWER

AST_CAUSE_CONGESTION

public static final HangupCause AST_CAUSE_CONGESTION

AST_CAUSE_UNREGISTERED

public static final HangupCause AST_CAUSE_UNREGISTERED

AST_CAUSE_NOTDEFINED

public static final HangupCause AST_CAUSE_NOTDEFINED

AST_CAUSE_NOSUCHDRIVER

public static final HangupCause AST_CAUSE_NOSUCHDRIVER
Method Detail

values

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

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

valueOf

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

getCode

public int getCode()
Returns the numeric cause code.

Using this method in client code is discouraged.

Returns:
the numeric cause code.

getByCode

public static HangupCause getByCode(int code)
Returns the HangupCode by its numeric cause code.

Using this method in client code is discouraged.

Parameters:
code - the numeric cause code.
Returns:
the corresponding HangupCode enum or null if there is no such HangupCause.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Enum<HangupCause>

Asterisk-Java

Copyright © 2004-2009 Stefan Reuter. All Rights Reserved.