DialogState (jain-sip-ri 1.2.299 API)

java.lang.Object
- javax.sip.DialogState

All Implemented Interfaces:

Serializable
```
public final class DialogState
extends Object
implements Serializable
```
This class contains the enumerations that define the underlying state of an existing dialog. There are three explicit states for a dialog, namely:
- Early - A dialog is in the "early" state, which occurs when it is created when a provisional response is recieved to the INVITE Request.
- Confirmed - A dialog transitions to the "confirmed" state when a 2xx final response is received to the INVITE Request.
- Terminated - A dialog transitions to the "terminated" state for all other reasons or if no response arrives at all on the dialog.
Version:

1.2

Author:

BEA Systems, NIST

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`_COMPLETED` Deprecated. Since v1.2. This state does not exist in a dialog.
`static int`	`_CONFIRMED` This constant value indicates the internal value of the "Confirmed" constant.
`static int`	`_EARLY` This constant value indicates the internal value of the "Early" constant.
`static int`	`_TERMINATED` This constant value indicates the internal value of the "Terminated" constant.
`static DialogState`	`COMPLETED` Deprecated. Since v1.2. This state does not exist in a dialog.
`static DialogState`	`CONFIRMED` This constant value indicates that the dialog state is "Confirmed".
`static DialogState`	`EARLY` This constant value indicates that the dialog state is "Early".
`static DialogState`	`TERMINATED` This constant value indicates that the dialog state is "Terminated".

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` Compare this dialog state for equality with another.
`static DialogState`	`getObject(int dialogState)` This method returns the object value of the DialogState
`int`	`getValue()` This method returns the integer value of the DialogState
`int`	`hashCode()` Get a hash code value for this dialog state.
`String`	`toString()` This method returns a string version of this class.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - _EARLY
```
public static final int _EARLY
```
    This constant value indicates the internal value of the "Early" constant.
    This constant has an integer value of 0.
    
    See Also:
    Constant Field Values
  - EARLY
```
public static final DialogState EARLY
```
    This constant value indicates that the dialog state is "Early".
  - _CONFIRMED
```
public static final int _CONFIRMED
```
    This constant value indicates the internal value of the "Confirmed" constant.
    This constant has an integer value of 1.
    
    See Also:
    Constant Field Values
  - CONFIRMED
```
public static final DialogState CONFIRMED
```
    This constant value indicates that the dialog state is "Confirmed".
  - _COMPLETED
```
public static final int _COMPLETED
```
    Deprecated. Since v1.2. This state does not exist in a dialog.
    
    This constant value indicates the internal value of the "Completed" constant.
    This constant has an integer value of 2.
    
    See Also:
    Constant Field Values
  - COMPLETED
```
public static final DialogState COMPLETED
```
    Deprecated. Since v1.2. This state does not exist in a dialog.
    
    This constant value indicates that the dialog state is "Completed".
  - _TERMINATED
```
public static final int _TERMINATED
```
    This constant value indicates the internal value of the "Terminated" constant.
    This constant has an integer value of 3.
    
    See Also:
    Constant Field Values
  - TERMINATED
```
public static final DialogState TERMINATED
```
    This constant value indicates that the dialog state is "Terminated".
- Method Detail
  - getObject
```
public static DialogState getObject(int dialogState)
```
    This method returns the object value of the DialogState
    
    Parameters:
    dialogState - The integer value of the DialogState
    
    Returns:
    The DialogState Object
  - getValue
```
public int getValue()
```
    This method returns the integer value of the DialogState
    
    Returns:
    The integer value of the DialogState
  - equals
```
public boolean equals(Object obj)
```
    Compare this dialog state for equality with another.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    obj - the object to compare this with.
    
    Returns:
    true if obj is an instance of this class representing the same dialog state as this, false otherwise.
    Since:
    
    1.2
  - hashCode
```
public int hashCode()
```
    Get a hash code value for this dialog state.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    a hash code value.
    Since:
    
    1.2
  - toString
```
public String toString()
```
    This method returns a string version of this class.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    The string version of the DialogState

Class DialogState

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_EARLY

EARLY

_CONFIRMED

CONFIRMED

_COMPLETED

COMPLETED

_TERMINATED

TERMINATED

Method Detail

getObject

getValue

equals

hashCode

toString