io.pkts.packet.sip.address

Class Address.Builder

java.lang.Object

io.pkts.packet.sip.address.Address.Builder

Enclosing interface:

Address

public static class Address.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
Address	build()
Address.Builder	withDisplayName(Buffer displayName)
Address.Builder	withDisplayName(String displayName)
Address.Builder	withHost(Buffer host) Use this host for the URI with this Address.
Address.Builder	withHost(String host)
Address.Builder	withNoParameters() Wipe out all parameters on the URI within the Address object.
Address.Builder	withPort(int port) Use this port for the SipURI that will be part of this Address.
Address.Builder	withTransport(Buffer transport)
Address.Builder	withTransport(String transport)
Address.Builder	withTransportSCTP() Set SCTP as the transport on the wrapped SIP URI (assuming this is a SIP URI that this Address object is indeed wrapping).
Address.Builder	withTransportTCP() Set TCP as the transport on the wrapped SIP URI (assuming this is a SIP URI that this Address object is indeed wrapping).
Address.Builder	withTransportTLS() Set TLS as the transport on the wrapped SIP URI (assuming this is a SIP URI that this Address object is indeed wrapping).
Address.Builder	withTransportUDP() Set UDP as the transport on the wrapped SIP URI (assuming this is a SIP URI that this Address object is indeed wrapping).
Address.Builder	withTransportWS() Set WS as the transport on the wrapped SIP URI (assuming this is a SIP URI that this Address object is indeed wrapping).
Address.Builder	withTransportWSS() Set WSS as the transport on the wrapped SIP URI (assuming this is a SIP URI that this Address object is indeed wrapping).
Address.Builder	withURI(URI uri)
Address.Builder	withURIParameter(Buffer name, Buffer value) Set a parameter on the URI within the Address object.
Address.Builder	withURIParameter(Buffer name, int value) Set a parameter on the URI within the Address object.
Address.Builder	withURIParameter(String name, int value) Set a parameter on the URI within the Address object.
Address.Builder	withURIParameter(String name, String value) Set a parameter on the URI within the Address object.
Address.Builder	withUser(Buffer user) Use this user for the SipURI that will be part of this Address.
Address.Builder	withUser(String user)

Methods inherited from class java.lang.Object

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

Method Detail

withUser

public Address.Builder withUser(Buffer user)

Use this user for the SipURI that will be part of this Address. See withHost(Buffer) for more information.

Parameters:

user -

Returns:

withUser

public Address.Builder withUser(String user)

withPort

public Address.Builder withPort(int port)

Use this port for the SipURI that will be part of this Address. See withHost(Buffer) for more information.

Parameters:

port -

Returns:

withURIParameter

public Address.Builder withURIParameter(Buffer name,
                                        Buffer value)
                                 throws SipParseException,
                                        IllegalArgumentException

Set a parameter on the URI within the Address object.

Parameters:

name -

value -

Returns:

Throws:

SipParseException

IllegalArgumentException

withURIParameter

public Address.Builder withURIParameter(String name,
                                        String value)
                                 throws SipParseException,
                                        IllegalArgumentException

Set a parameter on the URI within the Address object.

Parameters:

name -

value -

Returns:

Throws:

SipParseException

IllegalArgumentException

withURIParameter

public Address.Builder withURIParameter(String name,
                                        int value)
                                 throws SipParseException,
                                        IllegalArgumentException

Set a parameter on the URI within the Address object.

Parameters:

name -

value -

Returns:

Throws:

SipParseException

IllegalArgumentException

withURIParameter

public Address.Builder withURIParameter(Buffer name,
                                        int value)
                                 throws SipParseException,
                                        IllegalArgumentException

Set a parameter on the URI within the Address object.

Parameters:

name -

value -

Returns:

Throws:

SipParseException

IllegalArgumentException

withNoParameters

public Address.Builder withNoParameters()

Wipe out all parameters on the URI within the Address object. Useful if you e.g. create a copy of a SipURI but you want to remove any potential parameters that may be on the SIP URI.

Returns:

withTransportUDP

public Address.Builder withTransportUDP()

Set UDP as the transport on the wrapped SIP URI (assuming this is a SIP URI that this Address object is indeed wrapping).

Returns:

withTransportTCP

public Address.Builder withTransportTCP()

Set TCP as the transport on the wrapped SIP URI (assuming this is a SIP URI that this Address object is indeed wrapping).

Returns:

withTransportTLS

public Address.Builder withTransportTLS()

Set TLS as the transport on the wrapped SIP URI (assuming this is a SIP URI that this Address object is indeed wrapping).

Returns:

withTransportSCTP

public Address.Builder withTransportSCTP()

Set SCTP as the transport on the wrapped SIP URI (assuming this is a SIP URI that this Address object is indeed wrapping).

Returns:

withTransport

public Address.Builder withTransport(Buffer transport)
                              throws SipParseException

Throws:

SipParseException

withTransport

public Address.Builder withTransport(String transport)
                              throws SipParseException

Throws:

SipParseException

withTransportWS

public Address.Builder withTransportWS()

Set WS as the transport on the wrapped SIP URI (assuming this is a SIP URI that this Address object is indeed wrapping).

Returns:

withTransportWSS

public Address.Builder withTransportWSS()

Set WSS as the transport on the wrapped SIP URI (assuming this is a SIP URI that this Address object is indeed wrapping).

Returns:

withHost

public Address.Builder withHost(Buffer host)

Use this host for the URI with this Address. This is a convenient way of creating an Address with a SipURI and is the same as:

 SipURI uri = SipURI.with().host(host).build();
 Address.with(uri);
 

NOTE: you cannot specify a host and also specify a URI since those would conflict and an exception will occur at the time you try and build() the address.

Parameters:

host -

Returns:

withHost

public Address.Builder withHost(String host)

withDisplayName

public Address.Builder withDisplayName(Buffer displayName)

withDisplayName

public Address.Builder withDisplayName(String displayName)

withURI

public Address.Builder withURI(URI uri)

build

public Address build()
              throws SipParseException

Throws:

SipParseException