public interface FieldBuilder
RawField
instances from multiple lines
contained in ByteArrayBuffer
s.
Field builders are stateful and modal as they have to store intermediate results between
method invocations and also rely on a particular sequence of method invocations
(the mode of operation).
Consumers are expected to interact with field builder in the following way:
reset()
method in order to reset builder's internal state and make it
ready to start the process of building a new RawField
.append(ByteArrayBuffer)
method one or multiple times in order to build
an internal representation of a MIME field from individual lines of text.getRaw()
method can be invoked in order to get combined content
of all lines processed so far. Please note builder implementations can return
null
if they do not retain original raw content.build()
method in order to generate a RawField
instance
based on the internal state of the builder.Modifier and Type | Method and Description |
---|---|
void |
append(ByteArrayBuffer line)
Updates builder's internal state by adding a new line of text.
|
RawField |
build()
Builds an instance of
RawField based on the internal state. |
ByteArrayBuffer |
getRaw()
Returns combined content of all lines processed so far or
null
if the builder does not retain original raw content. |
void |
reset()
Resets the internal state of the builder making it ready to process new input.
|
void reset()
void append(ByteArrayBuffer line) throws MimeException
MimeException
RawField build() throws MimeException
RawField
based on the internal state.MimeException
ByteArrayBuffer getRaw()
null
if the builder does not retain original raw content.Copyright © 2004-2012 The Apache Software Foundation. All Rights Reserved.