org.codehaus.stax2.ri.typed

Class ValueEncoderFactory.StringEncoder

java.lang.Object

org.codehaus.stax2.ri.typed.AsciiValueEncoder

org.codehaus.stax2.ri.typed.ValueEncoderFactory.ScalarEncoder

org.codehaus.stax2.ri.typed.ValueEncoderFactory.StringEncoder

Enclosing class:

ValueEncoderFactory

static final class ValueEncoderFactory.StringEncoder
extends ValueEncoderFactory.ScalarEncoder

Implementation of textual encoder that operates on longer textual values. Because of length, it is possible that output has to be done in multiple pieces. As a result, there is need to track current position withing text.

In addition, instances of this class are not recycled, as it seems less beneficial (less likely to need to be reused, or offer performance improvements if they would be)

Field Summary

Fields

Modifier and Type	Field and Description
(package private) int	_offset
(package private) java.lang.String	_value

Fields inherited from class org.codehaus.stax2.ri.typed.AsciiValueEncoder

MIN_CHARS_WITHOUT_FLUSH

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StringEncoder(java.lang.String value)

Method Summary

Modifier and Type	Method and Description
int	encodeMore(byte[] buffer, int ptr, int end)
int	encodeMore(char[] buffer, int ptr, int end)
boolean	isCompleted() Method that can alternatively be called to determine whether encoder has encoded all data it has.

Methods inherited from class org.codehaus.stax2.ri.typed.AsciiValueEncoder

bufferNeedsFlush

Methods inherited from class java.lang.Object

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

Field Detail

_value

java.lang.String _value

_offset

int _offset

Constructor Detail

StringEncoder

protected StringEncoder(java.lang.String value)

Method Detail

isCompleted

public boolean isCompleted()

Description copied from class: AsciiValueEncoder

Method that can alternatively be called to determine whether encoder has encoded all data it has. Generally called right after a call to AsciiValueEncoder.encodeMore(char[], int, int), to figure out whether buffer flush is needed (there is more data), or encoding is complete.

Specified by:

isCompleted in class AsciiValueEncoder

encodeMore

public int encodeMore(char[] buffer,
                      int ptr,
                      int end)

Specified by:

encodeMore in class AsciiValueEncoder

Returns:

Value of pointer after all remaining data (which may be "none") that can be encoded (as constrained by buffer length) has been encoded. Has to exceed 'ptr' value sent in; will be equal to it if nothing was encoded (which should only occur when everything has been encoded, as long as AsciiValueEncoder.bufferNeedsFlush(int) is appropriately called once before calling this method)

encodeMore

public int encodeMore(byte[] buffer,
                      int ptr,
                      int end)

Specified by:

encodeMore in class AsciiValueEncoder

Returns:

Value of pointer after all remaining data (which may be "none") that can be encoded (as constrained by buffer length) has been encoded. Has to exceed 'ptr' value sent in; will be equal to it if nothing was encoded (which should only occur when everything has been encoded, as long as AsciiValueEncoder.bufferNeedsFlush(int) is appropriately called once before calling this method)