Package org.opensearch.core.compress

Class NoneCompressor

java.lang.Object

org.opensearch.core.compress.NoneCompressor

All Implemented Interfaces:

Compressor

public class NoneCompressor
extends Object
implements Compressor

Compressor no compressor implementation.

Opensearch.api:

- registered name requires BWC support

Opensearch.experimental:

- class methods might change

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	The name to register the compressor by

Constructor Summary

Constructors

Constructor	Description
NoneCompressor()

Method Summary

Modifier and Type	Method	Description
BytesReference	compress(BytesReference bytesReference)	Compress bytes into a newly allocated buffer.
int	headerLength()
boolean	isCompressed(BytesReference bytes)
InputStream	threadLocalInputStream(InputStream in)	Creates a new input stream that decompresses the contents read from the provided input stream.
OutputStream	threadLocalOutputStream(OutputStream out)	Creates a new output stream that compresses the contents and writes to the provided output stream.
BytesReference	uncompress(BytesReference bytesReference)	Decompress bytes into a newly allocated buffer.

Methods inherited from class java.lang.Object

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

Field Details

NAME

@PublicApi(since="2.10.0")
public static final String NAME

The name to register the compressor by

See Also:

• Constant Field Values

Opensearch.api:

- requires BWC support

Constructor Details

NoneCompressor

public NoneCompressor()

Method Details

isCompressed

public boolean isCompressed(BytesReference bytes)

Specified by:

isCompressed in interface Compressor

headerLength

public int headerLength()

Specified by:

headerLength in interface Compressor

threadLocalInputStream

public InputStream threadLocalInputStream(InputStream in)
                                   throws IOException

Description copied from interface: Compressor

Creates a new input stream that decompresses the contents read from the provided input stream. Closing the returned InputStream will close the provided stream input. Note: The returned stream may only be used on the thread that created it as it might use thread-local resources and must be safely closed after use

Specified by:

threadLocalInputStream in interface Compressor

Throws:

IOException

threadLocalOutputStream

public OutputStream threadLocalOutputStream(OutputStream out)
                                     throws IOException

Description copied from interface: Compressor

Creates a new output stream that compresses the contents and writes to the provided output stream. Closing the returned OutputStream will close the provided output stream. Note: The returned stream may only be used on the thread that created it as it might use thread-local resources and must be safely closed after use

Specified by:

threadLocalOutputStream in interface Compressor

Throws:

IOException

uncompress

public BytesReference uncompress(BytesReference bytesReference)
                          throws IOException

Description copied from interface: Compressor

Decompress bytes into a newly allocated buffer.

Specified by:

uncompress in interface Compressor

Parameters:

bytesReference - bytes to decompress

Returns:

decompressed bytes

Throws:

IOException

compress

public BytesReference compress(BytesReference bytesReference)
                        throws IOException

Description copied from interface: Compressor

Compress bytes into a newly allocated buffer.

Specified by:

compress in interface Compressor

Parameters:

bytesReference - bytes to compress

Returns:

compressed bytes

Throws:

IOException