jain.protocol.ip.sip.header
Class SubjectHeader

java.lang.Object
  |
  +--jain.protocol.ip.sip.header.Header
        |
        +--jain.protocol.ip.sip.header.RequestHeader
              |
              +--jain.protocol.ip.sip.header.SubjectHeader

public final class SubjectHeader

extends RequestHeader

This class represents the Subject request-header. The SubjectHeader is intended to provide a summary, or to indicate the nature, of the call, allowing call filtering without having to parse the session description. (Also, the session description does not have to use the same subject indication as the invitation.)

Version:

0.6

Field Summary

static java.lang.String

token Token of SubjectHeader

Fields inherited from class jain.protocol.ip.sip.header.Header

ENTITY_HEADER, GENERAL_HEADER, REQUEST_HEADER, RESPONSE_HEADER

Constructor Summary

SubjectHeader(java.lang.String subject)
Creates a SubjectHeader based on given subject

Method Summary

java.lang.Object	clone() Creates and returns a copy of SubjectHeader
boolean	equals(SubjectHeader subjectHeader) Indicates whether some other SubjectHeader is "equal to" this one
java.lang.String	getSubject() Gets subject of SubjectHeader
java.lang.String	getValue() Gets value of SubjectHeader
void	setSubject(java.lang.String subject) Sets subject of SubjectHeader

Methods inherited from class jain.protocol.ip.sip.header.Header

equals, getHeaderType, getToken, setValue, toString

Methods inherited from class java.lang.Object

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

Field Detail

token

public static final java.lang.String token

Token of SubjectHeader

Constructor Detail

SubjectHeader

public SubjectHeader(java.lang.String subject)
              throws java.lang.IllegalArgumentException

Creates a SubjectHeader based on given subject

Parameters:

subject - subject

Throws:

java.lang.IllegalArgumentException - if subject is null or zero-length

Method Detail

getSubject

public java.lang.String getSubject()

Gets subject of SubjectHeader

Returns:

subject of SubjectHeader

setSubject

public void setSubject(java.lang.String subject)
                throws java.lang.IllegalArgumentException

Sets subject of SubjectHeader

Parameters:

subject - subject

Throws:

java.lang.IllegalArgumentException - if subject is null or zero-length

getValue

public java.lang.String getValue()

Gets value of SubjectHeader

Overrides:

getValue in class Header

Returns:

value of SubjectHeader

clone

public java.lang.Object clone()

Creates and returns a copy of SubjectHeader

Overrides:

clone in class Header

equals

public boolean equals(SubjectHeader subjectHeader)

Indicates whether some other SubjectHeader is "equal to" this one

Parameters:

subjectHeader - the SubjectHeader with which to compare