io.pkts.packet.sip.address

Interface Address

All Known Implementing Classes:

AddressImpl

public interface Address

Represents an address and like everything else, it is an immutable class.

Author:

[email protected]

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Address.Builder

Method Summary

Modifier and Type	Method and Description
static Address.Builder	builder()
Address.Builder	copy() An Address is an immutable object so if you wish to change something you have to create a copy of it.
static Address	frame(Buffer buffer) Parses a SIP "name-addr" as defined by RFC3261 section 25.1:
static Address	frame(String buffer)
void	getBytes(Buffer dst)
Buffer	getDisplayName() Get the display name of this Address or an empty buffer if it is not set.
URI	getURI() Get the URI of this Address.
Buffer	toBuffer() Get the Address as a raw buffer.
static Address.Builder	withHost(Buffer host)
static Address.Builder	withHost(String host)
static Address.Builder	withURI(URI uri)

Method Detail

getDisplayName

Buffer getDisplayName()

Get the display name of this Address or an empty buffer if it is not set.

Returns:

getURI

URI getURI()
    throws SipParseException

Get the URI of this Address.

Returns:

the URI

Throws:

SipParseException

toBuffer

Buffer toBuffer()

Get the Address as a raw buffer.

Returns:

getBytes

void getBytes(Buffer dst)

copy

Address.Builder copy()

An Address is an immutable object so if you wish to change something you have to create a copy of it.

Returns:

frame

static Address frame(String buffer)
              throws SipParseException,
                     IndexOutOfBoundsException,
                     IOException

Throws:

SipParseException

IndexOutOfBoundsException

IOException

frame

static Address frame(Buffer buffer)
              throws SipParseException,
                     IndexOutOfBoundsException,
                     IOException

Parses a SIP "name-addr" as defined by RFC3261 section 25.1:

 name-addr      =  [ display-name ] LAQUOT addr-spec RAQUOT
 addr-spec      =  SIP-URI / SIPS-URI / absoluteURI
 display-name   =  *(token LWS)/ quoted-string
 

Parameters:

buffer -

Returns:

Throws:

SipParseException

IOException

IndexOutOfBoundsException

builder

static Address.Builder builder()

withHost

static Address.Builder withHost(Buffer host)

withHost

static Address.Builder withHost(String host)

withURI

static Address.Builder withURI(URI uri)