Interface Configuration
-
- All Known Implementing Classes:
ConfigurationImpl
public interface Configuration
Configuration interface for the ProtoStream library. This object is not mutable once built. Use theConfiguration.Builder
in order to create a new instance.- Since:
- 2.0
- Author:
- [email protected]
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
Configuration.AnnotationsConfig
static interface
Configuration.Builder
static interface
Configuration.WrappingConfig
-
Field Summary
Fields Modifier and Type Field Description static int
DEFAULT_MAX_NESTED_DEPTH
static String
TYPE_ID_ANNOTATION
The name of the TypeId annotation.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description Configuration.AnnotationsConfig
annotationsConfig()
static Configuration.Builder
builder()
boolean
logOutOfSequenceReads()
Flag that indicates in out of sequence reads should be logged as warnings.boolean
logOutOfSequenceWrites()
Flag that indicates in out of sequence writes should be logged as warnings.int
maxNestedMessageDepth()
The max nested message depth to apply to allGeneratedMarshallerBase
s.Configuration.WrappingConfig
wrappingConfig()
-
-
-
Field Detail
-
DEFAULT_MAX_NESTED_DEPTH
static final int DEFAULT_MAX_NESTED_DEPTH
- See Also:
- Constant Field Values
-
TYPE_ID_ANNOTATION
static final String TYPE_ID_ANNOTATION
The name of the TypeId annotation. This optional annotation defines a unique positive integer type identifier for each message or enum type. This can be used alternatively instead of the fully qualified type name during marshalling of a WrappedMessage to save bandwidth. Values in range [0..65535] are reserved for internal use by Protostream and related projects from the Infinispan organisation.This annotation is pre-defined in all configurations. You do not have to define it manually.
- See Also:
- Constant Field Values
-
-
Method Detail
-
logOutOfSequenceReads
boolean logOutOfSequenceReads()
Flag that indicates in out of sequence reads should be logged as warnings. This istrue
by default.
-
logOutOfSequenceWrites
boolean logOutOfSequenceWrites()
Flag that indicates in out of sequence writes should be logged as warnings. This istrue
by default.
-
maxNestedMessageDepth
int maxNestedMessageDepth()
The max nested message depth to apply to allGeneratedMarshallerBase
s. This value is used as way to avoid recurring on circular dependencies without the need to maintain the list of already visited entities. Default toDEFAULT_MAX_NESTED_DEPTH
-
wrappingConfig
Configuration.WrappingConfig wrappingConfig()
-
annotationsConfig
Configuration.AnnotationsConfig annotationsConfig()
-
builder
static Configuration.Builder builder()
-
-