io.pkts.packet.sip.header

Class AddressParametersHeader.Builder<T extends AddressParametersHeader>

java.lang.Object

io.pkts.packet.sip.header.AddressParametersHeader.Builder<T>

Direct Known Subclasses:

ContactHeader.Builder, FromHeader.Builder, ToHeader.Builder

Enclosing interface:

AddressParametersHeader

public static class AddressParametersHeader.Builder<T extends AddressParametersHeader>
extends java.lang.Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(Buffer name)

Method Summary

Modifier and Type	Method and Description
AddressParametersHeader.Builder<T>	address(Address address) Use this address for the ToHeader.
T	build() Build a new ToHeader.
AddressParametersHeader.Builder<T>	host(Buffer host) Use this host for the ToHeader.
AddressParametersHeader.Builder<T>	host(java.lang.String host)
protected T	internalBuild(Address address, Buffer params)
AddressParametersHeader.Builder<T>	parameter(Buffer name, Buffer value) Set a parameter on the header.
AddressParametersHeader.Builder<T>	parameter(java.lang.String name, java.lang.String value)
AddressParametersHeader.Builder<T>	port(int port)
AddressParametersHeader.Builder<T>	transportSCTP() Set the transport parameter on the underlying SipURI to be "sctp".
AddressParametersHeader.Builder<T>	transportTCP() Set the transport parameter on the underlying SipURI to be "tcp".
AddressParametersHeader.Builder<T>	transportTLS() Set the transport parameter on the underlying SipURI to be "tls".
AddressParametersHeader.Builder<T>	transportUDP() Set the transport parameter on the underlying SipURI to be "udp".
AddressParametersHeader.Builder<T>	transportWS() Set the transport parameter on the underlying SipURI to be "ws".
AddressParametersHeader.Builder<T>	uriParameter(Buffer name, Buffer value) Set a parameter on the underlying SipURI.
AddressParametersHeader.Builder<T>	uriParameter(java.lang.String name, java.lang.String value) Set a parameter on the underlying SipURI.
AddressParametersHeader.Builder<T>	user(Buffer user) Set the user portion of the ToHeader.
AddressParametersHeader.Builder<T>	user(java.lang.String user)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

protected Builder(Buffer name)

Method Detail

port

public final AddressParametersHeader.Builder<T> port(int port)

user

public final AddressParametersHeader.Builder<T> user(Buffer user)

Set the user portion of the ToHeader. Since the user portion may in fact be null (or empty), any value is accepted but of course, a value of null or empty will lead to no user portion of the SIP-URI within the header.

Parameters:

user -

Returns:

user

public final AddressParametersHeader.Builder<T> user(java.lang.String user)

host

public final AddressParametersHeader.Builder<T> host(Buffer host)

Use this host for the ToHeader. NOTE: you can only specify either an address or a host and user but not both. If you do, an exception will occur at the time you try and build() the header.

Parameters:

host -

Returns:

host

public final AddressParametersHeader.Builder<T> host(java.lang.String host)

parameter

public AddressParametersHeader.Builder<T> parameter(Buffer name,
                                                    Buffer value)
                                             throws SipParseException,
                                                    java.lang.IllegalArgumentException

Set a parameter on the header. NOTE: if you want to set a parameter on the URI you need to use the method uriParameter(Buffer, Buffer).

Parameters:

name -

value -

Returns:

Throws:

SipParseException

java.lang.IllegalArgumentException

parameter

public AddressParametersHeader.Builder<T> parameter(java.lang.String name,
                                                    java.lang.String value)
                                             throws SipParseException,
                                                    java.lang.IllegalArgumentException

Throws:

SipParseException

java.lang.IllegalArgumentException

uriParameter

public AddressParametersHeader.Builder<T> uriParameter(Buffer name,
                                                       Buffer value)
                                                throws SipParseException,
                                                       java.lang.IllegalArgumentException

Set a parameter on the underlying SipURI.

Parameters:

name -

value -

Returns:

Throws:

SipParseException

java.lang.IllegalArgumentException

uriParameter

public AddressParametersHeader.Builder<T> uriParameter(java.lang.String name,
                                                       java.lang.String value)
                                                throws SipParseException,
                                                       java.lang.IllegalArgumentException

Set a parameter on the underlying SipURI.

Parameters:

name -

value -

Returns:

Throws:

SipParseException

java.lang.IllegalArgumentException

transportTCP

public AddressParametersHeader.Builder<T> transportTCP()
                                                throws SipParseException

Set the transport parameter on the underlying SipURI to be "tcp".

Returns:

Throws:

SipParseException

transportUDP

public AddressParametersHeader.Builder<T> transportUDP()
                                                throws SipParseException

Set the transport parameter on the underlying SipURI to be "udp".

Returns:

Throws:

SipParseException

transportTLS

public AddressParametersHeader.Builder<T> transportTLS()
                                                throws SipParseException

Set the transport parameter on the underlying SipURI to be "tls".

Returns:

Throws:

SipParseException

transportSCTP

public AddressParametersHeader.Builder<T> transportSCTP()
                                                 throws SipParseException

Set the transport parameter on the underlying SipURI to be "sctp".

Returns:

Throws:

SipParseException

transportWS

public AddressParametersHeader.Builder<T> transportWS()
                                               throws SipParseException

Set the transport parameter on the underlying SipURI to be "ws".

Returns:

Throws:

SipParseException

address

public final AddressParametersHeader.Builder<T> address(Address address)

Use this address for the ToHeader. NOTE: you can only specify either an address or a host and user but not both. If you do, an exception will occur at the time you try and build() the header.

Parameters:

address -

Returns:

build

public final T build()
              throws SipParseException

Build a new ToHeader.

Returns:

Throws:

SipParseException - in case anything goes wrong while constructing the ToHeader.

internalBuild

protected T internalBuild(Address address,
                          Buffer params)