This is the input interface to the streaming encoding solution. Methods in this interface encode the given input and append it to the internal buffer
Type Params | Return Type | Name and description |
---|---|---|
|
void |
append(Encoder encoder, EncodingState encodingState, java.lang.CharSequence str, int off, int len) Encodes a portion of a string and appends it to the buffer. |
|
void |
append(Encoder encoder, EncodingState encodingState, char[] b, int off, int len) Encodes a portion of a char array and appends it to the buffer. |
|
void |
append(Encoder encoder, StreamEncodeable streamEncodeable) Encodes a StreamEncodeable instance and appends it to the buffer. |
|
void |
appendEncoded(Encoder encoder, EncodingState encodingState, java.lang.CharSequence str, int off, int len) Appends an encoded portion of a string to the buffer |
|
void |
appendEncoded(Encoder encoder, EncodingState encodingState, char[] b, int off, int len) Appends an encoded portion of a char array to the buffer. |
|
void |
close() |
|
void |
flush() Flush the internal buffer and write the buffered input to a possible destination. |
|
boolean |
isIgnoreEncodingState() @return current state of ignoreEncodingState setting |
|
void |
setIgnoreEncodingState(boolean ignoreEncodingState) When enabled, will encode all input regardless of it's current state disables double-encoding prevention. |
|
boolean |
shouldEncode(Encoder encoderToApply, EncodingState encodingState) Check if the encoder should be used to a input with certain encodingState |
Encodes a portion of a string and appends it to the buffer.
encoder
- the encoder to useencodingState
- the current encoding state of the stringstr
- A Stringoff
- Offset from which to start encoding characterslen
- Number of characters to encodeEncodes a portion of a char array and appends it to the buffer.
encoder
- the encoder to useencodingState
- the current encoding state of the stringb
- a char arrayoff
- Offset from which to start encoding characterslen
- Number of characters to encodeEncodes a StreamEncodeable instance and appends it to the buffer.
encoder
- the encoder to usestreamEncodeable
- the instance to encodeAppends an encoded portion of a string to the buffer
encoder
- the encoder that has been appliedencodingState
- the previous encoding state of the stringstr
- A Stringoff
- Offset from which to start encoding characterslen
- Number of characters to encodeAppends an encoded portion of a char array to the buffer.
encoder
- the encoder that has been appliedencodingState
- the previous encoding state of the char arrayb
- a char arrayoff
- Offset from which to start encoding characterslen
- Number of characters to encodeFlush the internal buffer and write the buffered input to a possible destination.
When enabled, will encode all input regardless of it's current state disables double-encoding prevention.
Check if the encoder should be used to a input with certain encodingState
encoderToApply
- the encoder to applyencodingState
- the current encoding state