org.lastbamboo.common.sdp.fields
Class KeyField

java.lang.Object
  org.lastbamboo.common.sdp.GenericObject
      org.lastbamboo.common.sdp.fields.SDPObject
          org.lastbamboo.common.sdp.fields.SDPField
              org.lastbamboo.common.sdp.fields.KeyField

All Implemented Interfaces:

Serializable, Cloneable, Field, Key, SDPFieldNames

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

protected String	keyData
protected String	type

Fields inherited from class org.lastbamboo.common.sdp.fields.SDPField

fieldName

Fields inherited from class org.lastbamboo.common.sdp.GenericObject

AND, AT, COLON, COMMA, DOT, DOUBLE_QUOTE, EQUALS, GREATER_THAN, HT, immutableClasses, immutableClassNames, indentation, LESS_THAN, LPAREN, matchExpression, NEWLINE, PERCENT, POUND, QUESTION, QUOTE, RETURN, RPAREN, SEMICOLON, SLASH, SP, STAR, stringRepresentation

Fields inherited from interface org.lastbamboo.common.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 org.lastbamboo.common.sdp.fields.SDPField

getFieldName, getTypeChar, toString

Methods inherited from class org.lastbamboo.common.sdp.fields.SDPObject

dbgPrint, debugDump, equals, getStringRepresentation, initSprint, match, merge, replace, replace, replace, replace, sprint

Methods inherited from class org.lastbamboo.common.sdp.GenericObject

Assert, clone, dbgPrint, dbgPrint, debugDump, getIndentation, getMatcher, isMySubclass, makeClone, setMatcher, sprint, sprint, sprint, sprint, sprint, sprint, sprint, sprint

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lastbamboo.common.sdp.api.Field

clone, getTypeChar

Field Detail

type

protected String type

keyData

protected String keyData

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