io.pkts.packet.sip.header

Interface ContentTypeHeader

All Superinterfaces:

Cloneable, MediaTypeHeader, Parameters, SipHeader

All Known Implementing Classes:

ContentTypeHeaderImpl

public interface ContentTypeHeader
extends SipHeader, MediaTypeHeader, Parameters

Represents the a content type header.

Author:

jonas@jonasborjesson.com

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ContentTypeHeader.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static Buffer	COMPACT_NAME
static Buffer	NAME

Fields inherited from interface io.pkts.packet.sip.header.SipHeader

CANNOT_CAST_HEADER_OF_TYPE, UNABLE_TO_PARSE_OUT_THE_HEADER_NAME_DUE_TO_UNDERLYING_IO_EXCEPTION

Method Summary

Modifier and Type	Method and Description
ContentTypeHeader	clone()
ContentTypeHeader.Builder	copy() Everything within the pkts.io SIP module are immutable so if you actually want to change anything you have to create a copy, which will return a specific Builder for that header.
static ContentTypeHeader	frame(Buffer buffer) Frame the value as a ContentTypeHeader.
default boolean	isContentTypeHeader()
default ContentTypeHeader	toContentTypeHeader()
static ContentTypeHeader.Builder	withParams(Buffer params)
static ContentTypeHeader.Builder	withType(Buffer type)
static ContentTypeHeader.Builder	withType(String type)

Methods inherited from interface io.pkts.packet.sip.header.MediaTypeHeader

getContentSubType, getContentType, isSDP

Methods inherited from interface io.pkts.packet.sip.header.Parameters

getParameter, getParameter, setParameter, setParameter

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

create, ensure, frame, getBufferSize, getBytes, getName, getNameStr, getValue, is, is, isAddressParametersHeader, isCallIdHeader, isContactHeader, isContentLengthHeader, isCSeqHeader, isExpiresHeader, isFromHeader, isMaxForwardsHeader, isRecordRouteHeader, isRouteHeader, isSubjectHeader, isSystemHeader, isToHeader, isViaHeader, toAddressParametersHeader, toCallIdHeader, toContactHeader, toContentLengthHeader, toCSeqHeader, toExpiresHeader, toFromHeader, toMaxForwardsHeader, toRecordRouteHeader, toRouteHeader, toToHeader, toViaHeader, verify

Field Detail

NAME

static final Buffer NAME

COMPACT_NAME

static final Buffer COMPACT_NAME

Method Detail

clone

ContentTypeHeader clone()

Specified by:

clone in interface SipHeader

copy

ContentTypeHeader.Builder copy()

Description copied from interface: SipHeader

Everything within the pkts.io SIP module are immutable so if you actually want to change anything you have to create a copy, which will return a specific Builder for that header.

Specified by:

copy in interface SipHeader

Returns:

isContentTypeHeader

default boolean isContentTypeHeader()

Specified by:

isContentTypeHeader in interface SipHeader

toContentTypeHeader

default ContentTypeHeader toContentTypeHeader()

Specified by:

toContentTypeHeader in interface SipHeader

frame

static ContentTypeHeader frame(Buffer buffer)
                        throws SipParseException

Frame the value as a ContentTypeHeader. This method assumes that you have already parsed out the actual header name "Content-Type: ". Also, this method assumes that a message framer (or similar) has framed the buffer that is being passed in to us to only contain this header and nothing else. Note, as with all the frame-methods on all headers/messages/whatever, they do not do any validation that the information is actually correct. This method will simply only try and validate just enough to get the framing done.

Specified by:

frame in interface MediaTypeHeader

Specified by:

frame in interface SipHeader

Parameters:

value -

Returns:

Throws:

SipParseException - in case anything goes wrong while parsing.

withType

static ContentTypeHeader.Builder withType(Buffer type)

withType

static ContentTypeHeader.Builder withType(String type)

withParams

static ContentTypeHeader.Builder withParams(Buffer params)