NIST SIP Parser and Stack (v1.2) API

javax.sdp
Interface Key

All Superinterfaces:
Cloneable, Field, Serializable

public interface Key
extends Field

A Key represents the k= field contained within either a MediaDescription or a SessionDescription. Please refer to IETF RFC 2327 for a description of SDP.

Version:
1.0
Author:
deruelle

Method Summary
 String getKey()
          Returns the value of this attribute.
 String getMethod()
          Returns the name of this attribute
 boolean hasKey()
          Determines if this attribute has an associated value.
 void setKey(String key)
          Sets the value of this attribute.
 void setMethod(String name)
          Sets the id of this attribute.
 
Methods inherited from interface javax.sdp.Field
clone, getTypeChar
 

Method Detail

getMethod

public String getMethod()
                 throws SdpParseException
Returns the name of this attribute

Returns:
the name of this attribute
Throws:
SdpParseException

setMethod

public void setMethod(String name)
               throws SdpException
Sets the id of this attribute.

Parameters:
name - to set
Throws:
SdpException - if the name is null

hasKey

public boolean hasKey()
               throws SdpParseException
Determines if this attribute has an associated value.

Returns:
if this attribute has an associated value.
Throws:
SdpParseException

getKey

public String getKey()
              throws SdpParseException
Returns the value of this attribute.

Returns:
the value of this attribute
Throws:
SdpParseException

setKey

public void setKey(String key)
            throws SdpException
Sets the value of this attribute.

Parameters:
key - to set
Throws:
SdpException - if key is null

NIST SIP Parser and Stack (v1.2) API

A product of the NIST/ITL Advanced Networking Technologies Division.
See conditions of use.
Get the latest distribution.
Submit a bug report or feature request.