Package com.fasterxml.jackson.databind
Class MappingIterator<T>
- java.lang.Object
-
- com.fasterxml.jackson.databind.MappingIterator<T>
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
,java.util.Iterator<T>
public class MappingIterator<T> extends java.lang.Object implements java.util.Iterator<T>, java.io.Closeable
Iterator exposed byObjectMapper
when binding sequence of objects. Extension is done to allow more convenient exposing ofIOException
(which basicIterator
does not expose)
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
static <T> MappingIterator<T>
emptyIterator()
Method for getting an "empty" iterator instance: one that never has more values; may be freely shared.JsonLocation
getCurrentLocation()
Convenience method, functionally equivalent to:iterator.getParser().getCurrentLocation()
JsonParser
getParser()
Accessor for getting underlying parser this iterator uses.FormatSchema
getParserSchema()
Accessor for accessingFormatSchema
that the underlying parser (as pergetParser()
) is using, if any; only parser of schema-aware formats use schemas.boolean
hasNext()
boolean
hasNextValue()
Equivalent ofnext()
but one that may throw checked exceptions from Jackson due to invalid input.T
next()
T
nextValue()
java.util.List<T>
readAll()
Convenience method for reading all entries accessible via this iterator; resulting container will be aArrayList
.<C extends java.util.Collection<? super T>>
CreadAll(C results)
Convenience method for reading all entries accessible via this iterator<L extends java.util.List<? super T>>
LreadAll(L resultList)
Convenience method for reading all entries accessible via this iteratorvoid
remove()
-
-
-
Method Detail
-
emptyIterator
public static <T> MappingIterator<T> emptyIterator()
Method for getting an "empty" iterator instance: one that never has more values; may be freely shared.- Since:
- 2.10 Existed earlier but
public
since 2.10
-
hasNext
public boolean hasNext()
- Specified by:
hasNext
in interfacejava.util.Iterator<T>
-
remove
public void remove()
- Specified by:
remove
in interfacejava.util.Iterator<T>
-
close
public void close() throws java.io.IOException
- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Throws:
java.io.IOException
-
hasNextValue
public boolean hasNextValue() throws java.io.IOException
Equivalent ofnext()
but one that may throw checked exceptions from Jackson due to invalid input.- Throws:
java.io.IOException
-
nextValue
public T nextValue() throws java.io.IOException
- Throws:
java.io.IOException
-
readAll
public java.util.List<T> readAll() throws java.io.IOException
Convenience method for reading all entries accessible via this iterator; resulting container will be aArrayList
.- Returns:
- List of entries read
- Throws:
java.io.IOException
- Since:
- 2.2
-
readAll
public <L extends java.util.List<? super T>> L readAll(L resultList) throws java.io.IOException
Convenience method for reading all entries accessible via this iterator- Returns:
- List of entries read (same as passed-in argument)
- Throws:
java.io.IOException
- Since:
- 2.2
-
readAll
public <C extends java.util.Collection<? super T>> C readAll(C results) throws java.io.IOException
Convenience method for reading all entries accessible via this iterator- Throws:
java.io.IOException
- Since:
- 2.5
-
getParser
public JsonParser getParser()
Accessor for getting underlying parser this iterator uses.- Since:
- 2.2
-
getParserSchema
public FormatSchema getParserSchema()
Accessor for accessingFormatSchema
that the underlying parser (as pergetParser()
) is using, if any; only parser of schema-aware formats use schemas.- Since:
- 2.2
-
getCurrentLocation
public JsonLocation getCurrentLocation()
Convenience method, functionally equivalent to:iterator.getParser().getCurrentLocation()
- Returns:
- Location of the input stream of the underlying parser
- Since:
- 2.2.1
-
-