io.pkts.packet.sip.header

Class AddressParametersHeader.Builder<T extends AddressParametersHeader>

java.lang.Object

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

All Implemented Interfaces:

SipHeader.Builder<T>

Direct Known Subclasses:

ContactHeader.Builder, FromHeader.Builder, RecordRouteHeader.Builder, RouteHeader.Builder, ToHeader.Builder

Enclosing interface:

AddressParametersHeader

public static class AddressParametersHeader.Builder<T extends AddressParametersHeader>
extends Object
implements SipHeader.Builder<T>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(Buffer name)
protected	Builder(Buffer name, ParametersSupport params)

Method Summary

Modifier and Type	Method and Description
T	build() Build a new ToHeader.
protected T	internalBuild(Buffer rawValue, Address address, Buffer params)
AddressParametersHeader.Builder<T>	withAddress(Address address) Use this address for the ToHeader.
AddressParametersHeader.Builder<T>	withDefaultTag() Convenience method for setting the value of the tag parameter to a default generated value.
AddressParametersHeader.Builder<T>	withDisplayName(Buffer displayName)
AddressParametersHeader.Builder<T>	withDisplayName(String displayName)
AddressParametersHeader.Builder<T>	withHost(Buffer host) Use this host for the ToHeader.
AddressParametersHeader.Builder<T>	withHost(String host)
AddressParametersHeader.Builder<T>	withNoParameters() Remove all header parameters.
AddressParametersHeader.Builder<T>	withNoTag() Convenience method for removing the tag paramter.
AddressParametersHeader.Builder<T>	withParameter(Buffer name, Buffer value) Set a parameter on the header.
AddressParametersHeader.Builder<T>	withParameter(String name, String value)
AddressParametersHeader.Builder<T>	withParameters(Buffer params) Set a bunch of parameters at the same time.
AddressParametersHeader.Builder<T>	withPort(int port)
AddressParametersHeader.Builder<T>	withTag(Buffer value) Convenience method for setting the tag parameter.
AddressParametersHeader.Builder<T>	withTag(String value) Convenience method for setting the tag parameter.
AddressParametersHeader.Builder<T>	withTransport(Buffer transport)
AddressParametersHeader.Builder<T>	withTransport(String transport)
AddressParametersHeader.Builder<T>	withTransportSCTP() Set the transport parameter on the underlying SipURI to be "sctp".
AddressParametersHeader.Builder<T>	withTransportTCP() Set the transport parameter on the underlying SipURI to be "tcp".
AddressParametersHeader.Builder<T>	withTransportTLS() Set the transport parameter on the underlying SipURI to be "tls".
AddressParametersHeader.Builder<T>	withTransportUDP() Set the transport parameter on the underlying SipURI to be "udp".
AddressParametersHeader.Builder<T>	withTransportWS() Set the transport parameter on the underlying SipURI to be "ws".
AddressParametersHeader.Builder<T>	withTransportWSS()
AddressParametersHeader.Builder<T>	withUriParameter(Buffer name, Buffer value) Set a parameter on the underlying SipURI.
AddressParametersHeader.Builder<T>	withUriParameter(String name, String value) Set a parameter on the underlying SipURI.
AddressParametersHeader.Builder<T>	withUser(Buffer user) Set the user portion of the ToHeader.
AddressParametersHeader.Builder<T>	withUser(String user)
AddressParametersHeader.Builder<T>	withValue(Buffer buffer)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.pkts.packet.sip.header.SipHeader.Builder

withValue

Constructor Detail

Builder

protected Builder(Buffer name)

Builder

protected Builder(Buffer name,
                  ParametersSupport params)

Method Detail

withValue

public final AddressParametersHeader.Builder<T> withValue(Buffer buffer)

Specified by:

withValue in interface SipHeader.Builder<T extends AddressParametersHeader>

withPort

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

withUser

public final AddressParametersHeader.Builder<T> withUser(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:

withUser

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

withDisplayName

public final AddressParametersHeader.Builder<T> withDisplayName(String displayName)

withDisplayName

public final AddressParametersHeader.Builder<T> withDisplayName(Buffer displayName)

withHost

public final AddressParametersHeader.Builder<T> withHost(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:

withHost

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

withNoTag

public AddressParametersHeader.Builder<T> withNoTag()
                                             throws SipParseException,
                                                    IllegalArgumentException

Convenience method for removing the tag paramter.

Returns:

Throws:

SipParseException

IllegalArgumentException

withTag

public AddressParametersHeader.Builder<T> withTag(Buffer value)
                                           throws SipParseException,
                                                  IllegalArgumentException

Convenience method for setting the tag parameter.

Parameters:

value -

Returns:

Throws:

SipParseException

IllegalArgumentException

withTag

public AddressParametersHeader.Builder<T> withTag(String value)
                                           throws SipParseException,
                                                  IllegalArgumentException

Convenience method for setting the tag parameter.

Parameters:

value -

Returns:

Throws:

SipParseException

IllegalArgumentException

withDefaultTag

public AddressParametersHeader.Builder<T> withDefaultTag()
                                                  throws SipParseException,
                                                         IllegalArgumentException

Convenience method for setting the value of the tag parameter to a default generated value.

Returns:

Throws:

SipParseException

IllegalArgumentException

withParameter

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

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

Parameters:

name -

value -

Returns:

Throws:

SipParseException

IllegalArgumentException

withParameter

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

Throws:

SipParseException

IllegalArgumentException

withParameters

public AddressParametersHeader.Builder<T> withParameters(Buffer params)

Set a bunch of parameters at the same time. WARNING! This one will wipe out any previously set parameters so be sure to call this one FIRST before any other calls to withParameter...

Parameters:

params -

Returns:

withNoParameters

public AddressParametersHeader.Builder<T> withNoParameters()

Remove all header parameters.

Returns:

withUriParameter

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

Set a parameter on the underlying SipURI.

Parameters:

name -

value -

Returns:

Throws:

SipParseException

IllegalArgumentException

withUriParameter

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

Set a parameter on the underlying SipURI.

Parameters:

name -

value -

Returns:

Throws:

SipParseException

IllegalArgumentException

withTransport

public AddressParametersHeader.Builder<T> withTransport(Buffer transport)
                                                 throws SipParseException

Throws:

SipParseException

withTransport

public AddressParametersHeader.Builder<T> withTransport(String transport)
                                                 throws SipParseException

Throws:

SipParseException

withTransportTCP

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

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

Returns:

Throws:

SipParseException

withTransportUDP

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

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

Returns:

Throws:

SipParseException

withTransportTLS

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

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

Returns:

Throws:

SipParseException

withTransportSCTP

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

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

Returns:

Throws:

SipParseException

withTransportWS

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

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

Returns:

Throws:

SipParseException

withTransportWSS

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

Throws:

SipParseException

withAddress

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

Use this address for the ToHeader. Note, if you already have specified any part of the address, such as the host, then this

Parameters:

address -

Returns:

Throws:

SipParseException - in case an address already has been specified either by a previous call to this method or by specifying parts of an address through e.g. withHost etc.

build

public final T build()
              throws SipParseException

Build a new ToHeader.

Specified by:

build in interface SipHeader.Builder<T extends AddressParametersHeader>

Returns:

Throws:

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

internalBuild

protected T internalBuild(Buffer rawValue,
                          Address address,
                          Buffer params)