NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

gov.nist.javax.sdp.fields
Class KeyField

java.lang.Object
  extended by gov.nist.core.GenericObject
      extended by gov.nist.javax.sdp.fields.SDPObject
          extended by gov.nist.javax.sdp.fields.SDPField
              extended by gov.nist.javax.sdp.fields.KeyField
All Implemented Interfaces:
SDPFieldNames, Serializable, Cloneable, Field, Key

public class KeyField
extends SDPField
implements Key

Key field part of an SDP header. Acknowledgement. Bug fix contributed by espen@java.net

Version:
JSR141-PUBLIC-REVIEW (subject to change)
Author:
Oliver Deruelle , M. Ranganathan
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface gov.nist.javax.sdp.fields.SDPFieldNames
ATTRIBUTE_FIELD, BANDWIDTH_FIELD, CONNECTION_FIELD, EMAIL_FIELD, INFORMATION_FIELD, KEY_FIELD, MEDIA_FIELD, ORIGIN_FIELD, PHONE_FIELD, PROTO_VERSION_FIELD, REPEAT_FIELD, SESSION_NAME_FIELD, TIME_FIELD, URI_FIELD, ZONE_FIELD
 
Constructor Summary
KeyField()
           
 
Method Summary
 String encode()
          Get the string encoded version of this object
 String getKey()
          Returns the value of this attribute.
 String getKeyData()
           
 String getMethod()
          Returns the name of this attribute
 String getType()
           
 boolean hasKey()
          Determines if this attribute has an associated value.
 void setKey(String key)
          Sets the value of this attribute.
 void setKeyData(String k)
          Set the keyData member
 void setMethod(String name)
          Sets the id of this attribute.
 void setType(String t)
          Set the type member
 
Methods inherited from class gov.nist.javax.sdp.fields.SDPField
getFieldName, getTypeChar, toString
 
Methods inherited from class gov.nist.javax.sdp.fields.SDPObject
dbgPrint, debugDump, equals, match
 
Methods inherited from class gov.nist.core.GenericObject
clone, debugDump, encode, getClassFromName, getMatcher, isMySubclass, makeClone, merge, setMatcher
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.sdp.Field
clone, getTypeChar
 

Constructor Detail

KeyField

public KeyField()
Method Detail

getType

public String getType()

getKeyData

public String getKeyData()

setType

public void setType(String t)
Set the type member


setKeyData

public void setKeyData(String k)
Set the keyData member


encode

public String encode()
Get the string encoded version of this object

Specified by:
encode in class SDPField
Since:
v1.0

getMethod

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

Specified by:
getMethod in interface Key
Returns:
the name of this attribute
Throws:
SdpParseException

setMethod

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

Specified by:
setMethod in interface Key
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.

Specified by:
hasKey in interface Key
Returns:
if this attribute has an associated value.
Throws:
SdpParseException

getKey

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

Specified by:
getKey in interface Key
Returns:
the value of this attribute
Throws:
SdpParseException

setKey

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

Specified by:
setKey in interface Key
Parameters:
key - to set
Throws:
SdpException - if key is null

NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

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