JAINTM MGCP API (DRAFT FOR PUBLIC REVIEW) - Version 0.9 - 16 NOVEMBER 2000

jain.protocol.ip.mgcp.message.parms
Class CapabilityValue

java.lang.Object
  |
  +--jain.protocol.ip.mgcp.message.parms.CapabilityValue
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
LocalOptVal, SupportedModes, SupportedPackages

public class CapabilityValue
extends java.lang.Object
implements java.io.Serializable

An abstract class that denotes a capability of an endpoint. Concrete derived classes can denote: (1) a Local Option Value (e.g., packetization period); (2) a list of supported MGCP packages (e.g., "D" for the DTMF package); (3) a list of supported connection modes (e.g., "sendonly").

See Also:
Serialized Form

Field Summary
static int LOCAL_OPTION_VALUE
          Constant used to specify a Local Option Value.
static int SUPPORTED_MODES
          Constant used to specify a list of supported connection modes.
static int SUPPORTED_PACKAGES
          Constant used to specify a list of supported MGCP event/signal packages.
 
Constructor Summary
protected CapabilityValue(int capabilityValueType)
           
 
Method Summary
 int getCapabilityValueType()
          Returns an integer value that signifies what type of capability value this CapabilityValue object represents.
 LocalOptionValue getLocalOptionValue()
          Returns the LocalOptionValue that is encapsulated by this CapabilityValue object.
 ConnectionMode[] getSupportedModes()
          Returns the list of supported connection modes that is encapsulated by this CapabilityValue object.
 PackageName[] getSupportedPackageNames()
          Returns the list of supported MGCP event/signal packages that is encapsulated by this CapabilityValue object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOCAL_OPTION_VALUE

public static final int LOCAL_OPTION_VALUE
Constant used to specify a Local Option Value.

SUPPORTED_MODES

public static final int SUPPORTED_MODES
Constant used to specify a list of supported connection modes.

SUPPORTED_PACKAGES

public static final int SUPPORTED_PACKAGES
Constant used to specify a list of supported MGCP event/signal packages.
Constructor Detail

CapabilityValue

protected CapabilityValue(int capabilityValueType)
Method Detail

getCapabilityValueType

public int getCapabilityValueType()
Returns an integer value that signifies what type of capability value this CapabilityValue object represents.
Returns:
An integer value that is one of three possible values: LOCAL_OPTION_VALUE; SUPPORTED_PACKAGES; or SUPPORTED_MODES.

getLocalOptionValue

public LocalOptionValue getLocalOptionValue()
                                     throws java.lang.NoSuchFieldException
Returns the LocalOptionValue that is encapsulated by this CapabilityValue object. Note that if this method is called from an instance of a derived class that does not represent a LocalOptionValue, an exception is thrown.
Throws:
java.lang.NoSuchFieldException - Thrown if this CapabilityValue object does not represent a Local Option Value.

getSupportedModes

public ConnectionMode[] getSupportedModes()
                                   throws java.lang.NoSuchFieldException
Returns the list of supported connection modes that is encapsulated by this CapabilityValue object. Note that if this method is called from an instance of a derived class that does not represent a list of supported connection modes, an exception is thrown.
Throws:
java.lang.NoSuchFieldException - Thrown if this CapabilityValue object does not represent a list of supported connection modes.

getSupportedPackageNames

public PackageName[] getSupportedPackageNames()
                                       throws java.lang.NoSuchFieldException
Returns the list of supported MGCP event/signal packages that is encapsulated by this CapabilityValue object. Note that if this method is called from an instance of a derived class that does not represent a list of supported MGCP event/signal packages, an exception is thrown.
Throws:
java.lang.NoSuchFieldException - Thrown if this CapabilityValue object does not represent a list of supported packages.

JAINTM MGCP API (DRAFT FOR PUBLIC REVIEW) - Version 0.9 - 16 NOVEMBER 2000

Copyright © 2000 Sun Microsystems, Inc.