Package com.mongodb
Class MongoCompressor
java.lang.Object
com.mongodb.MongoCompressor
Metadata describing a compressor to use for sending and receiving messages to a MongoDB server.
- Since:
- 3.6
- Since server release
- 3.4
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic MongoCompressor
Create an instance for snappy compression.static MongoCompressor
Create an instance for zlib compression.static MongoCompressor
Create an instance for zstd compression.boolean
getName()
Gets the name of the compressor.<T> T
getProperty
(String key, T defaultValue) Gets the property with the given key.<T> T
getPropertyNonNull
(String key, T defaultValue) Gets the property with the given key.int
hashCode()
toString()
<T> MongoCompressor
withProperty
(String key, T value) Creates a new compressor from this compressor with the given property added to it.
-
Field Details
-
LEVEL
The property key for defining the compression level.- See Also:
-
-
Method Details
-
createSnappyCompressor
Create an instance for snappy compression.- Returns:
- A compressor based on the snappy compression algorithm
- Since server release
- 3.4
-
createZlibCompressor
Create an instance for zlib compression.- Returns:
- A compressor based on the zlib compression algorithm
- Since server release
- 3.6
-
createZstdCompressor
Create an instance for zstd compression.- Returns:
- A compressor based on the zstd compression algorithm
- Since server release
- 4.2
-
getName
Gets the name of the compressor.- Returns:
- the non-null compressor name
-
getProperty
Gets the property with the given key.- Type Parameters:
T
- the property value type- Parameters:
key
- the keydefaultValue
- the default value- Returns:
- the property value, or the default value if the property is not defined
-
getPropertyNonNull
Gets the property with the given key.- Type Parameters:
T
- the property value type- Parameters:
key
- the keydefaultValue
- the default value- Returns:
- the property value, or the default value if the property is not defined
- Throws:
IllegalArgumentException
- if the value and default value are null- Since:
- 3.7
-
withProperty
Creates a new compressor from this compressor with the given property added to it.- Type Parameters:
T
- the property value type- Parameters:
key
- the property keyvalue
- the property value- Returns:
- the new compressor
-
equals
-
hashCode
public int hashCode() -
toString
-