org.lastbamboo.common.sdp.fields
Class AttributeField

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.AttributeField

All Implemented Interfaces:

Serializable, Cloneable, Attribute, Field, SDPFieldNames

public class AttributeField
extends SDPField
implements Attribute

Attribute Field.

Version:

JSR141-PUBLIC-REVIEW (subject to change).

Author:

Olivier Deruelle , M. Ranganathan
This code is in the public domain.

See Also:

Serialized Form

Field Summary

protected NameValue

attribute

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

AttributeField()

Method Summary

Object	clone() Clones this object.
String	encode() Get the string encoded version of this object
NameValue	getAttribute()
String	getName() Returns the name of this attribute
String	getValue() Returns the value of this attribute.
boolean	hasValue() Determines if this attribute has an associated value.
void	setAttribute(NameValue a) Set the attribute member
void	setName(String name) Sets the id of this attribute.
void	setValue(String value) Sets the value of this attribute.
String	toString()

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

getFieldName, getTypeChar

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, 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

getTypeChar

Field Detail

attribute

protected NameValue attribute

Constructor Detail

AttributeField

public AttributeField()

Method Detail

getAttribute

public NameValue getAttribute()

setAttribute

public void setAttribute(NameValue a)

Set the attribute member

encode

public String encode()

Get the string encoded version of this object

Specified by:

encode in class SDPField

Since:

v1.0

toString

public String toString()

Overrides:

toString in class SDPField

getName

public String getName()
               throws SdpParseException

Returns the name of this attribute

Specified by:

getName in interface Attribute

Returns:

a String identity or null.

Throws:

SdpParseException - if the name is not well formatted.

setName

public void setName(String name)
             throws SdpException

Sets the id of this attribute.

Specified by:

setName in interface Attribute

Parameters:

name - the string name/id of the attribute.

Throws:

SdpException - if the name is null

hasValue

public boolean hasValue()
                 throws SdpParseException

Determines if this attribute has an associated value.

Specified by:

hasValue in interface Attribute

Returns:

true if the attribute has a value.

Throws:

SdpParseException - if the value is not well formatted.

getValue

public String getValue()
                throws SdpParseException

Returns the value of this attribute.

Specified by:

getValue in interface Attribute

Returns:

the value; null if the attribute has no associated value.

Throws:

SdpParseException - if the value is not well formatted.

setValue

public void setValue(String value)
              throws SdpException

Sets the value of this attribute.

Specified by:

setValue in interface Attribute

Parameters:

value - the - attribute value

Throws:

SdpException - if the value is null.

clone

public Object clone()

Description copied from class: GenericObject

Clones this object.

Specified by:

clone in interface Field

Overrides:

clone in class GenericObject

Returns:

a clone of this field.