gov.nist.javax.sdp
クラス SessionDescriptionImpl

java.lang.Object
  gov.nist.javax.sdp.SessionDescriptionImpl

すべての実装されたインタフェース:

java.io.Serializable, java.lang.Cloneable, javax.sdp.SessionDescription

public class SessionDescriptionImpl
extends java.lang.Object
implements javax.sdp.SessionDescription

Implementation of the SessionDescription interface.

バージョン:

JSR141-PUBLIC-REVIEW

作成者:

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

関連項目:

直列化された形式

コンストラクタの概要

SessionDescriptionImpl()
Creates new SessionDescriptionImpl

メソッドの概要

void	addField(SDPField sdpField)
java.lang.Object	clone() Public clone declaration.
java.lang.String	getAttribute(java.lang.String name) Returns the value of the specified attribute.
java.util.Vector	getAttributes(boolean create) Returns the set of attributes for this Description as a Vector of Attribute objects in the order they were parsed.
int	getBandwidth(java.lang.String name) Returns the integer value of the specified bandwidth name.
java.util.Vector	getBandwidths(boolean create) Returns the Bandwidth of the specified type.
javax.sdp.Connection	getConnection() Returns the connection information associated with this object.
java.util.Vector	getEmails(boolean create) Returns an email address to contact for further information about the session.
javax.sdp.Info	getInfo() Returns value of the info field (i=) of this object.
javax.sdp.Key	getKey() Returns the key data.
java.util.Vector	getMediaDescriptions(boolean create) Adds a MediaDescription to the session description.
javax.sdp.Origin	getOrigin() Returns information about the originator of the session.
java.util.Vector	getPhones(boolean create) Returns a phone number to contact for further information about the session.
javax.sdp.SessionName	getSessionName() Returns the name of the session.
java.util.Vector	getTimeDescriptions(boolean create) Returns a TimeField indicating the start, stop, repetition and time zone information of the session.
javax.sdp.URI	getURI() Returns a uri to the location of more details about the session.
javax.sdp.Version	getVersion() Returns the version of SDP in use.
java.util.Vector	getZoneAdjustments(boolean create) Returns the time zone adjustments for the Session
void	removeAttribute(java.lang.String name) Removes the attribute specified by the value parameter.
void	removeBandwidth(java.lang.String name) Removes the specified bandwidth type.
void	setAttribute(java.lang.String name, java.lang.String value) Sets the value of the specified attribute.
void	setAttributes(java.util.Vector attributes) Adds the specified Attribute to this Description object.
void	setBandwidth(java.lang.String name, int value) Sets the value of the specified bandwidth type.
void	setBandwidths(java.util.Vector bandwidthList) set the value of the Bandwidth with the specified type.
void	setConnection(javax.sdp.Connection conn) Set the connection data for this entity.
void	setEmails(java.util.Vector emails) Sets a an email address to contact for further information about the session.
void	setInfo(javax.sdp.Info i) Sets the i= field of this object.
void	setKey(javax.sdp.Key key) Sets encryption key information.
void	setMediaDescriptions(java.util.Vector mediaDescriptions) Removes all MediaDescriptions from the session description.
void	setOrigin(javax.sdp.Origin origin) Sets information about the originator of the session.
void	setPhones(java.util.Vector phones) Sets a phone number to contact for further information about the session.
void	setSessionName(javax.sdp.SessionName sessionName) Sets the name of the session.
void	setTimeDescriptions(java.util.Vector times) Sets a TimeField indicating the start, stop, repetition and time zone information of the session.
void	setURI(javax.sdp.URI uri) Sets the uri to the location of more details about the session.
void	setVersion(javax.sdp.Version v) Sets the version of SDP in use.
void	setZoneAdjustments(java.util.Vector zoneAdjustments) Sets the time zone adjustment for the TimeField.
java.lang.String	toString() Returns the canonical string representation of the current SessionDescrption.

クラス java.lang.Object から継承されたメソッド

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

SessionDescriptionImpl

public SessionDescriptionImpl()

Creates new SessionDescriptionImpl

メソッドの詳細

addField

public void addField(SDPField sdpField)
              throws java.text.ParseException

例外:

java.text.ParseException

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Public clone declaration.

定義:

インタフェース javax.sdp.SessionDescription 内の clone

オーバーライド:

クラス java.lang.Object 内の clone

戻り値:

Object

例外:

java.lang.CloneNotSupportedException - if clone method is not supported

getVersion

public javax.sdp.Version getVersion()

Returns the version of SDP in use. This corresponds to the v= field of the SDP data.

定義:

インタフェース javax.sdp.SessionDescription 内の getVersion

戻り値:

the integer version (-1 if not set).

setVersion

public void setVersion(javax.sdp.Version v)
                throws javax.sdp.SdpException

Sets the version of SDP in use. This corresponds to the v= field of the SDP data.

定義:

インタフェース javax.sdp.SessionDescription 内の setVersion

パラメータ:

v - version - the integer version.

例外:

javax.sdp.SdpException - if the version is null

getOrigin

public javax.sdp.Origin getOrigin()

Returns information about the originator of the session. This corresponds to the o= field of the SDP data.

定義:

インタフェース javax.sdp.SessionDescription 内の getOrigin

戻り値:

the originator data.

setOrigin

public void setOrigin(javax.sdp.Origin origin)
               throws javax.sdp.SdpException

Sets information about the originator of the session. This corresponds to the o= field of the SDP data.

定義:

インタフェース javax.sdp.SessionDescription 内の setOrigin

パラメータ:

origin - origin - the originator data.

例外:

javax.sdp.SdpException - if the origin is null

getSessionName

public javax.sdp.SessionName getSessionName()

Returns the name of the session. This corresponds to the s= field of the SDP data.

定義:

インタフェース javax.sdp.SessionDescription 内の getSessionName

戻り値:

the session name.

setSessionName

public void setSessionName(javax.sdp.SessionName sessionName)
                    throws javax.sdp.SdpException

Sets the name of the session. This corresponds to the s= field of the SDP data.

定義:

インタフェース javax.sdp.SessionDescription 内の setSessionName

パラメータ:

sessionName - name - the session name.

例外:

javax.sdp.SdpException - if the sessionName is null

getInfo

public javax.sdp.Info getInfo()

Returns value of the info field (i=) of this object.

定義:

インタフェース javax.sdp.SessionDescription 内の getInfo

戻り値:

info

setInfo

public void setInfo(javax.sdp.Info i)
             throws javax.sdp.SdpException

Sets the i= field of this object.

定義:

インタフェース javax.sdp.SessionDescription 内の setInfo

パラメータ:

i - s - new i= value; if null removes the field

例外:

javax.sdp.SdpException - if the info is null

getURI

public javax.sdp.URI getURI()

Returns a uri to the location of more details about the session. This corresponds to the u= field of the SDP data.

定義:

インタフェース javax.sdp.SessionDescription 内の getURI

戻り値:

the uri.

setURI

public void setURI(javax.sdp.URI uri)
            throws javax.sdp.SdpException

Sets the uri to the location of more details about the session. This corresponds to the u= field of the SDP data.

定義:

インタフェース javax.sdp.SessionDescription 内の setURI

パラメータ:

uri - uri - the uri.

例外:

javax.sdp.SdpException - if the uri is null

getEmails

public java.util.Vector getEmails(boolean create)
                           throws javax.sdp.SdpParseException

Returns an email address to contact for further information about the session. This corresponds to the e= field of the SDP data.

定義:

インタフェース javax.sdp.SessionDescription 内の getEmails

パラメータ:

create - boolean to set

戻り値:

the email address.

例外:

javax.sdp.SdpException

javax.sdp.SdpParseException

setEmails

public void setEmails(java.util.Vector emails)
               throws javax.sdp.SdpException

Sets a an email address to contact for further information about the session. This corresponds to the e= field of the SDP data.

定義:

インタフェース javax.sdp.SessionDescription 内の setEmails

パラメータ:

emails - email - the email address.

例外:

javax.sdp.SdpException - if the vector is null

getPhones

public java.util.Vector getPhones(boolean create)
                           throws javax.sdp.SdpException

Returns a phone number to contact for further information about the session. This corresponds to the p= field of the SDP data.

定義:

インタフェース javax.sdp.SessionDescription 内の getPhones

パラメータ:

create - boolean to set

戻り値:

the phone number.

例外:

javax.sdp.SdpException

setPhones

public void setPhones(java.util.Vector phones)
               throws javax.sdp.SdpException

Sets a phone number to contact for further information about the session. This corresponds to the p= field of the SDP data.

定義:

インタフェース javax.sdp.SessionDescription 内の setPhones

パラメータ:

phones - phone - the phone number.

例外:

javax.sdp.SdpException - if the vector is null

getTimeDescriptions

public java.util.Vector getTimeDescriptions(boolean create)
                                     throws javax.sdp.SdpException

Returns a TimeField indicating the start, stop, repetition and time zone information of the session. This corresponds to the t= field of the SDP data.

定義:

インタフェース javax.sdp.SessionDescription 内の getTimeDescriptions

パラメータ:

create - boolean to set

戻り値:

the Time Field.

例外:

javax.sdp.SdpException

setTimeDescriptions

public void setTimeDescriptions(java.util.Vector times)
                         throws javax.sdp.SdpException

Sets a TimeField indicating the start, stop, repetition and time zone information of the session. This corresponds to the t= field of the SDP data.

定義:

インタフェース javax.sdp.SessionDescription 内の setTimeDescriptions

パラメータ:

times - time - the TimeField.

例外:

javax.sdp.SdpException - if the vector is null

getZoneAdjustments

public java.util.Vector getZoneAdjustments(boolean create)
                                    throws javax.sdp.SdpException

Returns the time zone adjustments for the Session

定義:

インタフェース javax.sdp.SessionDescription 内の getZoneAdjustments

パラメータ:

create - boolean to set

戻り値:

a Hashtable containing the zone adjustments, where the key is the Adjusted Time Zone and the value is the offset.

例外:

javax.sdp.SdpException

setZoneAdjustments

public void setZoneAdjustments(java.util.Vector zoneAdjustments)
                        throws javax.sdp.SdpException

Sets the time zone adjustment for the TimeField.

定義:

インタフェース javax.sdp.SessionDescription 内の setZoneAdjustments

パラメータ:

zoneAdjustments - zoneAdjustments - a Hashtable containing the zone adjustments, where the key is the Adjusted Time Zone and the value is the offset.

例外:

javax.sdp.SdpException - if the vector is null

getConnection

public javax.sdp.Connection getConnection()

Returns the connection information associated with this object. This may be null for SessionDescriptions if all Media objects have a connection object and may be null for Media objects if the corresponding session connection is non-null.

定義:

インタフェース javax.sdp.SessionDescription 内の getConnection

戻り値:

connection

setConnection

public void setConnection(javax.sdp.Connection conn)
                   throws javax.sdp.SdpException

Set the connection data for this entity.

定義:

インタフェース javax.sdp.SessionDescription 内の setConnection

パラメータ:

conn - to set

例外:

javax.sdp.SdpException - if the parameter is null

getBandwidths

public java.util.Vector getBandwidths(boolean create)

Returns the Bandwidth of the specified type.

定義:

インタフェース javax.sdp.SessionDescription 内の getBandwidths

パラメータ:

create - type - type of the Bandwidth to return

戻り値:

the Bandwidth or null if undefined

setBandwidths

public void setBandwidths(java.util.Vector bandwidthList)
                   throws javax.sdp.SdpException

set the value of the Bandwidth with the specified type.

定義:

インタフェース javax.sdp.SessionDescription 内の setBandwidths

パラメータ:

bandwidthList - to set

例外:

javax.sdp.SdpException - if the vector is null

getBandwidth

public int getBandwidth(java.lang.String name)
                 throws javax.sdp.SdpParseException

Returns the integer value of the specified bandwidth name.

定義:

インタフェース javax.sdp.SessionDescription 内の getBandwidth

パラメータ:

name - name - the name of the bandwidth type

戻り値:

the value of the named bandwidth

例外:

javax.sdp.SdpParseException

setBandwidth

public void setBandwidth(java.lang.String name,
                         int value)
                  throws javax.sdp.SdpException

Sets the value of the specified bandwidth type.

定義:

インタフェース javax.sdp.SessionDescription 内の setBandwidth

パラメータ:

name - name - the name of the bandwidth type.

value - value - the value of the named bandwidth type.

例外:

javax.sdp.SdpException - if the name is null

removeBandwidth

public void removeBandwidth(java.lang.String name)

Removes the specified bandwidth type.

定義:

インタフェース javax.sdp.SessionDescription 内の removeBandwidth

パラメータ:

name - name - the name of the bandwidth type

getKey

public javax.sdp.Key getKey()

Returns the key data.

定義:

インタフェース javax.sdp.SessionDescription 内の getKey

戻り値:

key

setKey

public void setKey(javax.sdp.Key key)
            throws javax.sdp.SdpException

Sets encryption key information. This consists of a method and an encryption key included inline.

定義:

インタフェース javax.sdp.SessionDescription 内の setKey

パラメータ:

key - key - the encryption key data; depending on method may be null

例外:

javax.sdp.SdpException - if the parameter is null

getAttribute

public java.lang.String getAttribute(java.lang.String name)
                              throws javax.sdp.SdpParseException

Returns the value of the specified attribute.

定義:

インタフェース javax.sdp.SessionDescription 内の getAttribute

パラメータ:

name - name - the name of the attribute

戻り値:

the value of the named attribute

例外:

javax.sdp.SdpParseException

getAttributes

public java.util.Vector getAttributes(boolean create)

Returns the set of attributes for this Description as a Vector of Attribute objects in the order they were parsed.

定義:

インタフェース javax.sdp.SessionDescription 内の getAttributes

パラメータ:

create - create - specifies whether to return null or a new empty Vector in case no attributes exists for this Description

戻り値:

attributes for this Description

removeAttribute

public void removeAttribute(java.lang.String name)

Removes the attribute specified by the value parameter.

定義:

インタフェース javax.sdp.SessionDescription 内の removeAttribute

パラメータ:

name - name - the name of the attribute

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.String value)
                  throws javax.sdp.SdpException

Sets the value of the specified attribute.

定義:

インタフェース javax.sdp.SessionDescription 内の setAttribute

パラメータ:

name - name - the name of the attribute.

value - value - the value of the named attribute.

例外:

javax.sdp.SdpException - if the name or the value is null

setAttributes

public void setAttributes(java.util.Vector attributes)
                   throws javax.sdp.SdpException

Adds the specified Attribute to this Description object.

定義:

インタフェース javax.sdp.SessionDescription 内の setAttributes

パラメータ:

Attributes - attribute - the attribute to add

例外:

javax.sdp.SdpException - if the vector is null

getMediaDescriptions

public java.util.Vector getMediaDescriptions(boolean create)
                                      throws javax.sdp.SdpException

Adds a MediaDescription to the session description. These correspond to the m= fields of the SDP data.

定義:

インタフェース javax.sdp.SessionDescription 内の getMediaDescriptions

パラメータ:

create - boolean to set

戻り値:

media - the field to add.

例外:

javax.sdp.SdpException

setMediaDescriptions

public void setMediaDescriptions(java.util.Vector mediaDescriptions)
                          throws javax.sdp.SdpException

Removes all MediaDescriptions from the session description.

定義:

インタフェース javax.sdp.SessionDescription 内の setMediaDescriptions

パラメータ:

mediaDescriptions - to set

例外:

javax.sdp.SdpException - if the parameter is null

toString

public java.lang.String toString()

Returns the canonical string representation of the current SessionDescrption. Acknowledgement - this code was contributed by Emil Ivov.

オーバーライド:

クラス java.lang.Object 内の toString

戻り値:

Returns the canonical string representation of the current SessionDescrption.