Package org.openhab.core.io.rest

Class Stream2JSONInputStream

java.lang.Object

java.io.InputStream

org.openhab.core.io.rest.Stream2JSONInputStream

All Implemented Interfaces:

Closeable, AutoCloseable, JSONInputStream

@NonNullByDefault
public class Stream2JSONInputStream
extends InputStream
implements JSONInputStream

This InputStream will stream Streams as JSON one item at a time. This will reduce memory usage when streaming large collections through the REST interface. The input stream creates one JSON representation at a time from the top level elements of the stream. For best performance a flattened stream should be provided. Otherwise a nested collections JSON representation will be fully transformed into memory.

Author:

Henning Treu - Initial contribution, Jörg Sautter - Use as SequenceInputStream to simplify the logic

Constructor Summary

Constructors

Constructor	Description
Stream2JSONInputStream(Stream<?> source)	Creates a new Stream2JSONInputStream backed by the given Stream source.

Method Summary

Modifier and Type	Method	Description
void	close()
int	read()
int	read(byte @Nullable [] b, int off, int len)
long	transferTo(OutputStream target)

Methods inherited from class java.io.InputStream

available, mark, markSupported, nullInputStream, read, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes

Methods inherited from class java.lang.Object

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

Constructor Details

Stream2JSONInputStream

public Stream2JSONInputStream(Stream<?> source)

Creates a new Stream2JSONInputStream backed by the given Stream source.

Parameters:

source - the Stream backing this input stream. Must not be null.

Method Details

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte @Nullable [] b,
 int off,
 int len)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

transferTo

public long transferTo(OutputStream target)
                throws IOException

Overrides:

transferTo in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException