jackson-databind 2.16.0 · com.fasterxml.jackson.databind.MappingIterator

Field Summary

Modifier and Type	Field and Description
protected final boolean	_closeParser Flag that indicates whether input `JsonParser` should be closed when we are done or not; generally only called when caller did not pass JsonParser.
protected final DeserializationContext	_context Context for deserialization, needed to pass through to deserializer
protected final JsonDeserializer<T>	_deserializer Deserializer for individual element values.
protected final JsonParser	_parser Underlying parser used for reading content to bind.
protected final JsonStreamContext	_seqContext Context to resynchronize to, in case an exception is encountered but caller wants to try to read more elements.
protected int	_state State of the iterator
protected final JavaType	_type Type to bind individual elements to.
protected final T	_updatedValue If not null, "value to update" instead of creating a new instance for each call.
protected static final MappingIterator<?>	EMPTY_ITERATOR
protected static final int	STATE_CLOSED State in which iterator is closed
protected static final int	STATE_HAS_VALUE State in which "hasNextValue()" has been succesfully called and deserializer can be called to fetch value
protected static final int	STATE_MAY_HAVE_VALUE State in which no recovery is needed, but "hasNextValue()" needs to be called first
protected static final int	STATE_NEED_RESYNC State in which value read failed

Constructor Summary

Access	Constructor and Description
protected	MappingIterator(JavaType type, JsonParser p, DeserializationContext ctxt, JsonDeserializer<?> deser, boolean Whether we "own" the `JsonParser` passed or not: if true, it was created by `ObjectReader` and code here needs to close it; if false, it was passed by calling code and should not be closed by iterator. managedParser, Object valueToUpdate)

Method Summary

Modifier and Type	Method and Description
protected <R> R	_handleIOException(IOException e)
protected <R> R	_handleMappingException(JsonMappingException e)
protected void	_resync()
protected <R> R	_throwNoSuchElement()
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
public static <T> MappingIterator<T>	emptyIterator() Method for getting an "empty" iterator instance: one that never has more values; may be freely shared.
public JsonLocation	Returns: Location of the input stream of the underlying parser getCurrentLocation() Convenience method, functionally equivalent to: `iterator.getParser().getCurrentLocation()`
public JsonParser	getParser() Accessor for getting underlying parser this iterator uses.
public FormatSchema	getParserSchema() Accessor for accessing `FormatSchema` that the underlying parser (as per `getParser`) is using, if any; only parser of schema-aware formats use schemas.
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public boolean	hasNextValue() Equivalent of `next` but one that may throw checked exceptions from Jackson due to invalid input.
public T	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public T	nextValue()
public List<T>	Returns: List of entries read readAll() Convenience method for reading all entries accessible via this iterator; resulting container will be a `java.util.ArrayList`.
public <L extends List<? super T>> L	Returns: List of entries read (same as passed-in argument) readAll(L resultList) Convenience method for reading all entries accessible via this iterator
public <C extends Collection<? super T>> C	readAll(C results) Convenience method for reading all entries accessible via this iterator
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_closeParser	back to summary
protected final boolean _closeParser Flag that indicates whether input `JsonParser` should be closed when we are done or not; generally only called when caller did not pass JsonParser.

_context	back to summary
protected final DeserializationContext _context Context for deserialization, needed to pass through to deserializer

_deserializer	back to summary
protected final JsonDeserializer<T> _deserializer Deserializer for individual element values.

_parser	back to summary
protected final JsonParser _parser Underlying parser used for reading content to bind. Initialized as not `null` but set as `null` when iterator is closed, to denote closing.

_seqContext	back to summary
protected final JsonStreamContext _seqContext Context to resynchronize to, in case an exception is encountered but caller wants to try to read more elements.

_state	back to summary
protected int _state State of the iterator

_type	back to summary
protected final JavaType _type Type to bind individual elements to.

_updatedValue	back to summary
protected final T _updatedValue If not null, "value to update" instead of creating a new instance for each call.

EMPTY_ITERATOR	back to summary
protected static final MappingIterator<?> EMPTY_ITERATOR

STATE_CLOSED	back to summary
protected static final int STATE_CLOSED State in which iterator is closed

STATE_HAS_VALUE	back to summary
protected static final int STATE_HAS_VALUE State in which "hasNextValue()" has been succesfully called and deserializer can be called to fetch value

STATE_MAY_HAVE_VALUE	back to summary
protected static final int STATE_MAY_HAVE_VALUE State in which no recovery is needed, but "hasNextValue()" needs to be called first

STATE_NEED_RESYNC	back to summary
protected static final int STATE_NEED_RESYNC State in which value read failed

Constructor Detail

MappingIterator back to summary

MappingIterator	back to summary
protected MappingIterator(JavaType type, JsonParser p, DeserializationContext ctxt, JsonDeserializer<?> deser, boolean managedParser, Object valueToUpdate) Parameters managedParser:boolean Whether we "own" the `JsonParser` passed or not: if true, it was created by `ObjectReader` and code here needs to close it; if false, it was passed by calling code and should not be closed by iterator. Annotations @SuppressWarnings:unchecked

protected MappingIterator(JavaType type, JsonParser p, DeserializationContext ctxt, JsonDeserializer<?> deser, boolean managedParser, Object valueToUpdate)

Parameters

managedParser:boolean: Whether we "own" the JsonParser passed or not: if true, it was created by ObjectReader and code here needs to close it; if false, it was passed by calling code and should not be closed by iterator.

Annotations

@SuppressWarnings:unchecked

Method Detail

_handleIOException	back to summary
protected <R> R _handleIOException(IOException e)

_handleMappingException	back to summary
protected <R> R _handleMappingException(JsonMappingException e)

_resync	back to summary
protected void _resync() throws IOException

_throwNoSuchElement	back to summary
protected <R> R _throwNoSuchElement()

close back to summary

close	back to summary
public void close() throws IOException Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override Exceptions IOException: if an I/O error occurs

public void close() throws IOException

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

emptyIterator back to summary

emptyIterator	back to summary
public static <T> MappingIterator<T> emptyIterator() Method for getting an "empty" iterator instance: one that never has more values; may be freely shared. Annotations @SuppressWarnings:unchecked Since 2.10 Existed earlier but `public` since 2.10

public static <T> MappingIterator<T> emptyIterator()

Method for getting an "empty" iterator instance: one that never has more values; may be freely shared.

Annotations

@SuppressWarnings:unchecked

Since

2.10 Existed earlier but public since 2.10

getCurrentLocation back to summary

getCurrentLocation	back to summary
public JsonLocation getCurrentLocation() Convenience method, functionally equivalent to: `iterator.getParser().getCurrentLocation()` Returns:JsonLocation Location of the input stream of the underlying parser Since 2.2.1

public JsonLocation getCurrentLocation()

Convenience method, functionally equivalent to: iterator.getParser().getCurrentLocation()

Returns:JsonLocation: Location of the input stream of the underlying parser
Since: 2.2.1

getParser	back to summary
public JsonParser getParser() Accessor for getting underlying parser this iterator uses. Since 2.2

getParser

back to summary

public JsonParser getParser()

Accessor for getting underlying parser this iterator uses.

Since: 2.2

getParserSchema back to summary

getParserSchema	back to summary
public FormatSchema getParserSchema() Accessor for accessing `FormatSchema` that the underlying parser (as per `getParser`) is using, if any; only parser of schema-aware formats use schemas. Since 2.2

public FormatSchema getParserSchema()

Accessor for accessing FormatSchema that the underlying parser (as per getParser) is using, if any; only parser of schema-aware formats use schemas.

Since: 2.2

hasNext back to summary

hasNext	back to summary
public boolean hasNext() Implements java.util.Iterator.hasNext. Doc from java.util.Iterator.hasNext. Returns `true` if the iteration has more elements. (In other words, returns `true` if `next` would return an element rather than throwing an exception.) Returns:boolean `true` if the iteration has more elements Annotations @Override

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns:boolean

true if the iteration has more elements

Annotations

@Override

hasNextValue	back to summary
public boolean hasNextValue() throws IOException Equivalent of `next` but one that may throw checked exceptions from Jackson due to invalid input.

next	back to summary
public T next() Implements java.util.Iterator.next. Doc from java.util.Iterator.next. Returns the next element in the iteration. Returns:T the next element in the iteration Annotations @SuppressWarnings:unchecked @Override

back to summary

public T next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

Returns:T

the next element in the iteration

Annotations

@SuppressWarnings:unchecked
@Override

nextValue	back to summary
public T nextValue() throws IOException

readAll back to summary

readAll	back to summary
public List<T> readAll() throws IOException Convenience method for reading all entries accessible via this iterator; resulting container will be a `java.util.ArrayList`. Returns:List<T> List of entries read Since 2.2

public List<T> readAll() throws IOException

Convenience method for reading all entries accessible via this iterator; resulting container will be a java.util.ArrayList.

Returns:List<T>: List of entries read
Since: 2.2

readAll	back to summary
public <L extends List<? super T>> L readAll(L resultList) throws IOException Convenience method for reading all entries accessible via this iterator Returns:L List of entries read (same as passed-in argument) Since 2.2

readAll

back to summary

public <L extends List<? super T>> L readAll(L resultList) throws IOException

Convenience method for reading all entries accessible via this iterator

Returns:L: List of entries read (same as passed-in argument)
Since: 2.2

readAll	back to summary
public <C extends Collection<? super T>> C readAll(C results) throws IOException Convenience method for reading all entries accessible via this iterator Since 2.5

readAll

back to summary

public <C extends Collection<? super T>> C readAll(C results) throws IOException

Convenience method for reading all entries accessible via this iterator

Since: 2.5

remove back to summary

remove	back to summary
public void remove() Overrides default java.util.Iterator.remove. Doc from java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to `next`. The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy. The behavior of an iterator is unspecified if this method is called after a call to the `forEachRemaining` method. Annotations @Override

public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

Annotations

@Override

public Class MappingIterator<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail