jain.protocol.ip.sip.header
Class DateHeader

java.lang.Object
  |
  +--jain.protocol.ip.sip.header.Header
        |
        +--jain.protocol.ip.sip.header.GeneralHeader
              |
              +--jain.protocol.ip.sip.header.DateHeader

public final class DateHeader

extends GeneralHeader

This class represents the Date general header. DateHeader reflects the time when the request or response is first sent. Thus, retransmissions have the same Date header field value as the original.

The DateHeader can be used by simple end systems without a battery-backed clock to acquire a notion of current time.

Version:

0.6

Field Summary

static java.lang.String

token Token of DateHeader

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

ENTITY_HEADER, GENERAL_HEADER, REQUEST_HEADER, RESPONSE_HEADER

Constructor Summary

DateHeader(java.util.Date date)
Creates an DateHeader based on given Date

DateHeader(java.lang.String date)
Creates a DateHeader based on given date string

Method Summary

java.lang.Object	clone() Creates and returns a copy of DateHeader
boolean	equals(DateHeader dateHeader) Indicates whether some other DateHeader is "equal to" this one
java.util.Date	getDate() Gets date of DateHeader
java.lang.String	getValue() Gets value of DateHeader
void	setDate(java.util.Date date) Set date of DateHeader
void	setDate(java.lang.String date) Set date of DateHeader

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 DateHeader

Constructor Detail

DateHeader

public DateHeader(java.lang.String date)
           throws java.text.ParseException,
                  java.lang.IllegalArgumentException

Creates a DateHeader based on given date string

Parameters:

date - date string

Throws:

java.lang.IllegalArgumentException - if date string is null or zero-length

java.text.ParseException - if date string cannot be parsed as a date

DateHeader

public DateHeader(java.util.Date date)

Creates an DateHeader based on given Date

Parameters:

date - Date

Throws:

java.lang.IllegalArgumentException - if date is null

Method Detail

getDate

public java.util.Date getDate()

Gets date of DateHeader

Returns:

date of DateHeader

setDate

public void setDate(java.lang.String date)
             throws java.text.ParseException,
                    java.lang.IllegalArgumentException

Set date of DateHeader

Parameters:

date - Date string

Throws:

java.lang.IllegalArgumentException - if date string is null or zero-length

java.text.ParseException - if date string cannot be parsed as a date

setDate

public void setDate(java.util.Date date)
             throws java.lang.IllegalArgumentException

Set date of DateHeader

Parameters:

date - Date

Throws:

java.lang.IllegalArgumentException - if date is null

getValue

public java.lang.String getValue()

Gets value of DateHeader

Overrides:

getValue in class Header

Returns:

value of DateHeader

clone

public java.lang.Object clone()

Creates and returns a copy of DateHeader

Overrides:

clone in class Header

equals

public boolean equals(DateHeader dateHeader)

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

Parameters:

dateHeader - the DateHeader with which to compare