Module org.elasticsearch.server

Package org.elasticsearch.common.io.stream

Class TruncatedOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

org.elasticsearch.common.io.stream.TruncatedOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class TruncatedOutputStream
extends FilterOutputStream

Truncates writes once the max size is exceeded. However, when writing byte arrays, the stream does not check whether there is capacity for the full array prior to writing, so there is overspill of up to b.length - 1.

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor	Description
TruncatedOutputStream(OutputStream out, IntSupplier currentSizeSupplier, int maxSize)

Method Summary

Modifier and Type	Method	Description
boolean	hasCapacity()
void	write(byte[] b)	If there is at least one byte of space left in the stream then writes the byte stream.
void	write(byte[] b, int off, int len)	If there is at least one byte of space left in the stream then writes the byte stream.
void	write(int b)	If there is at least one byte of space left in the stream then write the byte

Methods inherited from class java.io.FilterOutputStream

close, flush

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

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

Constructor Details

TruncatedOutputStream

public TruncatedOutputStream(OutputStream out,
 IntSupplier currentSizeSupplier,
 int maxSize)

Method Details

hasCapacity

public boolean hasCapacity()

Returns:

True if there is at least one byte of space left to write

write

public void write(int b)
           throws IOException

If there is at least one byte of space left in the stream then write the byte

Overrides:

write in class FilterOutputStream

Parameters:

b - The byte to write to the underlying stream

Throws:

IOException - – if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

write

public void write(byte[] b)
           throws IOException

If there is at least one byte of space left in the stream then writes the byte stream. Therefore, up to b.length - 1 bytes will overflow.

Overrides:

write in class FilterOutputStream

Parameters:

b - The bytes to write to the underlying stream

Throws:

IOException - – if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

write

public void write(byte[] b,
 int off,
 int len)
           throws IOException

If there is at least one byte of space left in the stream then writes the byte stream. Therefore, up to len - 1 bytes will overflow.

Overrides:

write in class FilterOutputStream

Parameters:

b - The byte array to write from

off - The index of the first byte to write.

len - The number of bytes to write

Throws:

IOException - – if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.