MsgPackParserBuilder (Apache Juneau (incubating) 6.1.1-incubating-SNAPSHOT)

java.lang.Object
+
- org.apache.juneau.CoreObjectBuilder
- +
  - org.apache.juneau.parser.ParserBuilder
  - +
    - org.apache.juneau.msgpack.MsgPackParserBuilder
    +
  +
+

+
+
+
```
public class MsgPackParserBuilder
+extends ParserBuilder
```
+
Builder class for building instances of MessagePack parsers.
+

+ +

+ + +
Field Summary
+
- + + +
  Fields inherited from class org.apache.juneau.CoreObjectBuilder
  +propertyStore
+

+ +

+ + +
Constructor Summary
+ + + + + + + + + + + +
Constructors
Constructor and Description
MsgPackParserBuilder() +
Constructor, default settings.
+
MsgPackParserBuilder(PropertyStore propertyStore) +
Constructor.
+
+

Constructors
Constructor and Description
`MsgPackParserBuilder()` + Constructor, default settings. +
`MsgPackParserBuilder(PropertyStore propertyStore)` + Constructor. +

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MsgPackParserBuilder`	`addToProperty(String name, + Object value)` + Adds a value to a SET property. +
`MsgPackParserBuilder`	`apply(PropertyStore copyFrom)` + Copies the settings from the specified property store into this builder. +
`MsgPackParserBuilder`	`beanClassVisibility(Visibility value)` + Configuration property: Look for bean classes with the specified minimum visibility. +
`MsgPackParserBuilder`	`beanConstructorVisibility(Visibility value)` + Configuration property: Look for bean constructors with the specified minimum visibility. +
`MsgPackParserBuilder`	`beanDictionary(Class<?>... values)` + Configuration property: Add to bean dictionary. +
`MsgPackParserBuilder`	`beanDictionary(Collection<Class<?>> values)` + Configuration property: Add to bean dictionary. +
`MsgPackParserBuilder`	`beanFieldVisibility(Visibility value)` + Configuration property: Look for bean fields with the specified minimum visibility. +
`MsgPackParserBuilder`	`beanFilters(Class<?>... values)` + Configuration property: Add to bean filters. +
`MsgPackParserBuilder`	`beanFilters(Collection<Class<?>> values)` + Configuration property: Add to bean filters. +
`MsgPackParserBuilder`	`beanMapPutReturnsOldValue(boolean value)` + Configuration property: `BeanMap.put()` method will return old property value. +
`MsgPackParserBuilder`	`beansRequireDefaultConstructor(boolean value)` + Configuration property: Beans require no-arg constructors. +
`MsgPackParserBuilder`	`beansRequireSerializable(boolean value)` + Configuration property: Beans require `Serializable` interface. +
`MsgPackParserBuilder`	`beansRequireSettersForGetters(boolean value)` + Configuration property: Beans require setters for getters. +
`MsgPackParserBuilder`	`beansRequireSomeProperties(boolean value)` + Configuration property: Beans require at least one property. +
`MsgPackParserBuilder`	`beanTypePropertyName(String value)` + Configuration property: Name to use for the bean type properties used to represent a bean type. +
`MsgPackParser`	`build()` + Build the object. +
`MsgPackParserBuilder`	`classLoader(ClassLoader classLoader)` + Sets the classloader used for created classes from class strings. +
`MsgPackParserBuilder`	`debug(boolean value)` + Configuration property: Debug mode. +
`MsgPackParserBuilder`	`defaultParser(Class<?> value)` + Configuration property: Default parser to use when converting `Strings` to POJOs. +
`MsgPackParserBuilder`	`fileCharset(String value)` + Configuration property: File charset. +
`MsgPackParserBuilder`	`ignoreInvocationExceptionsOnGetters(boolean value)` + Configuration property: Ignore invocation errors on getters. +
`MsgPackParserBuilder`	`ignoreInvocationExceptionsOnSetters(boolean value)` + Configuration property: Ignore invocation errors on setters. +
`MsgPackParserBuilder`	`ignorePropertiesWithoutSetters(boolean value)` + Configuration property: Ignore properties without setters. +
`MsgPackParserBuilder`	`ignoreUnknownBeanProperties(boolean value)` + Configuration property: Ignore unknown properties. +
`MsgPackParserBuilder`	`ignoreUnknownNullBeanProperties(boolean value)` + Configuration property: Ignore unknown properties with null values. +
`<T> MsgPackParserBuilder`	`implClass(Class<T> interfaceClass, + Class<? extends T> implClass)` + Configuration property: Implementation classes for interfaces and abstract classes. +
`MsgPackParserBuilder`	`implClasses(Map<Class<?>,Class<?>> values)` + Configuration property: Implementation classes for interfaces and abstract classes. +
`MsgPackParserBuilder`	`inputStreamCharset(String value)` + Configuration property: Input stream charset. +
`MsgPackParserBuilder`	`locale(Locale value)` + Configuration property: Locale. +
`MsgPackParserBuilder`	`mediaType(MediaType value)` + Configuration property: Media type. +
`MsgPackParserBuilder`	`methodVisibility(Visibility value)` + Configuration property: Look for bean methods with the specified minimum visibility. +
`MsgPackParserBuilder`	`notBeanClasses(Class<?>... values)` + Configuration property: Add to classes that should not be considered beans. +
`MsgPackParserBuilder`	`notBeanClasses(Collection<Class<?>> values)` + Configuration property: Add to classes that should not be considered beans. +
`MsgPackParserBuilder`	`notBeanPackages(Collection<String> values)` + Configuration property: Add to packages whose classes should not be considered beans. +
`MsgPackParserBuilder`	`notBeanPackages(String... values)` + Configuration property: Add to packages whose classes should not be considered beans. +
`MsgPackParserBuilder`	`pojoSwaps(Class<?>... values)` + Configuration property: Add to POJO swaps. +
`MsgPackParserBuilder`	`pojoSwaps(Collection<Class<?>> values)` + Configuration property: Add to POJO swaps. +
`MsgPackParserBuilder`	`properties(Map<String,Object> properties)` + Adds multiple configuration properties on this object. +
`MsgPackParserBuilder`	`property(String name, + Object value)` + Sets a configuration property on this object. +
`MsgPackParserBuilder`	`putToProperty(String name, + Object value)` + Adds or overwrites a value to a MAP property. +
`MsgPackParserBuilder`	`putToProperty(String name, + Object key, + Object value)` + Adds or overwrites a value to a MAP property. +
`MsgPackParserBuilder`	`removeBeanFilters(Class<?>... values)` + Configuration property: Remove from bean filters. +
`MsgPackParserBuilder`	`removeBeanFilters(Collection<Class<?>> values)` + Configuration property: Remove from bean filters. +
`MsgPackParserBuilder`	`removeFromBeanDictionary(Class<?>... values)` + Configuration property: Remove from bean dictionary. +
`MsgPackParserBuilder`	`removeFromBeanDictionary(Collection<Class<?>> values)` + Configuration property: Remove from bean dictionary. +
`MsgPackParserBuilder`	`removeFromProperty(String name, + Object value)` + Removes a value from a SET property. +
`MsgPackParserBuilder`	`removeNotBeanClasses(Class<?>... values)` + Configuration property: Remove from classes that should not be considered beans. +
`MsgPackParserBuilder`	`removeNotBeanClasses(Collection<Class<?>> values)` + Configuration property: Remove from classes that should not be considered beans. +
`MsgPackParserBuilder`	`removeNotBeanPackages(Collection<String> values)` + Configuration property: Remove from packages whose classes should not be considered beans. +
`MsgPackParserBuilder`	`removeNotBeanPackages(String... values)` + Configuration property: Remove from packages whose classes should not be considered beans. +
`MsgPackParserBuilder`	`removePojoSwaps(Class<?>... values)` + Configuration property: Remove from POJO swaps. +
`MsgPackParserBuilder`	`removePojoSwaps(Collection<Class<?>> values)` + Configuration property: Remove from POJO swaps. +
`MsgPackParserBuilder`	`setBeanDictionary(Class<?>... values)` + Configuration property: Bean lookup dictionary. +
`MsgPackParserBuilder`	`setBeanDictionary(Collection<Class<?>> values)` + Configuration property: Bean lookup dictionary. +
`MsgPackParserBuilder`	`setBeanFilters(Class<?>... values)` + Configuration property: Bean filters to apply to beans. +
`MsgPackParserBuilder`	`setBeanFilters(Collection<Class<?>> values)` + Configuration property: Bean filters to apply to beans. +
`MsgPackParserBuilder`	`setNotBeanClasses(Class<?>... values)` + Configuration property: Classes to be excluded from consideration as being beans. +
`MsgPackParserBuilder`	`setNotBeanClasses(Collection<Class<?>> values)` + Configuration property: Classes to be excluded from consideration as being beans. +
`MsgPackParserBuilder`	`setNotBeanPackages(Collection<String> values)` + Configuration property: Packages whose classes should not be considered beans. +
`MsgPackParserBuilder`	`setNotBeanPackages(String... values)` + Configuration property: Packages whose classes should not be considered beans. +
`MsgPackParserBuilder`	`setPojoSwaps(Class<?>... values)` + Configuration property: POJO swaps to apply to Java objects. +
`MsgPackParserBuilder`	`setPojoSwaps(Collection<Class<?>> values)` + Configuration property: POJO swaps to apply to Java objects. +
`MsgPackParserBuilder`	`sortProperties(boolean value)` + Configuration property: Sort bean properties in alphabetical order. +
`MsgPackParserBuilder`	`strict()` + Shortcut for calling `strict(true)`. +
`MsgPackParserBuilder`	`strict(boolean value)` + Configuration property: Strict mode. +
`MsgPackParserBuilder`	`timeZone(TimeZone value)` + Configuration property: TimeZone. +
`MsgPackParserBuilder`	`trimStrings(boolean value)` + Configuration property: Trim parsed strings. +
`MsgPackParserBuilder`	`useInterfaceProxies(boolean value)` + Configuration property: Use interface proxies. +
`MsgPackParserBuilder`	`useJavaBeanIntrospector(boolean value)` + Configuration property: Use Java `Introspector` for determining bean properties. +

+ + +
Methods inherited from class org.apache.juneau.CoreObjectBuilder
+build, setProperties

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +

+ + +
Constructor Detail
+ + + +
- +
  MsgPackParserBuilder
  +
```
public MsgPackParserBuilder()
```
  +
  Constructor, default settings.
  +
+ + + +
- +
  MsgPackParserBuilder
  +
```
public MsgPackParserBuilder(PropertyStore propertyStore)
```
  +
  Constructor.
  +
  +
  Parameters:
  +
  propertyStore - The initial configuration settings for this builder.
  +
  +
+

+ +

+ + +

Method Detail

+ + + +

+
build
+
```
public MsgPackParser build()
```
+
Description copied from class: CoreObjectBuilder
+
Build the object.
+
+
Overrides:
+
build in class ParserBuilder
+
Returns:
+
The built object. + Subsequent calls to this method will create new instances.
+
+

+ + + +

+
trimStrings
+
```
public MsgPackParserBuilder trimStrings(boolean value)
```
+
Description copied from class: ParserBuilder
+
Configuration property: Trim parsed strings. +
+
- Name: "Parser.trimStrings" +
- Data type: Boolean +
- Default: false +
- Session-overridable: true +
+
+ If true, string values will be trimmed of whitespace using String.trim() before being added to the POJO. +
+
Notes:
+
- This is equivalent to calling property(PARSER_trimStrings, value). +
+
+
Overrides:
+
trimStrings in class ParserBuilder
+
Parameters:
+
value - The new value for this property.
+
Returns:
+
This object (for method chaining).
+
See Also:
+
ParserContext.PARSER_trimStrings
+
+

+ + + +

strict

public MsgPackParserBuilder strict(boolean value)

Description copied from class: ParserBuilder

Configuration property: Strict mode. +

Name: "Parser.strict" +
Data type: Boolean +
Default: false +
Session-overridable: true +

+ If true, strict mode for the parser is enabled. +

+ Strict mode can mean different things for different parsers. +

+ + + + + + + + + + +
Parser class Strict behavior
All reader-based parsers + When enabled, throws ParseExceptions on malformed charset input. + Otherwise, malformed input is ignored. +
JsonParser + When enabled, throws exceptions on the following invalid JSON syntax: +
+
Unquoted attributes. +
Missing attribute values. +
Concatenated strings. +
Javascript comments. +
Numbers and booleans when Strings are expected. +
Numbers valid in Java but not JSON (e.g. octal notation, etc...) +
+
+

Parser class	Strict behavior
All reader-based parsers	+ When enabled, throws `ParseExceptions` on malformed charset input. + Otherwise, malformed input is ignored. +
`JsonParser`	+ When enabled, throws exceptions on the following invalid JSON syntax: + + Unquoted attributes. + Missing attribute values. + Concatenated strings. + Javascript comments. + Numbers and booleans when Strings are expected. + Numbers valid in Java but not JSON (e.g. octal notation, etc...) + +

Notes:

This is equivalent to calling property(PARSER_strict,value). +

Overrides:: strict in class ParserBuilder
Parameters:: value - The new value for this property.
Returns:: This object (for method chaining).
See Also:: ParserContext.PARSER_strict

+ + + +

+
strict
+
```
public MsgPackParserBuilder strict()
```
+
Description copied from class: ParserBuilder
+
Shortcut for calling strict(true).
+
+
Overrides:
+
strict in class ParserBuilder
+
Returns:
+
This object (for method chaining).
+
+

+ + + +

+
inputStreamCharset
+
```
public MsgPackParserBuilder inputStreamCharset(String value)
```
+
Description copied from class: ParserBuilder
+
Configuration property: Input stream charset. +
+
- Name: "Parser.inputStreamCharset" +
- Data type: String +
- Default: "UTF-8" +
- Session-overridable: true +
+
+ The character set to use for converting InputStreams and byte arrays to readers. +
+ Used when passing in input streams and byte arrays to Parser.parse(Object, Class). +
+
Notes:
+
- This is equivalent to calling property(PARSER_inputStreamCharset, value). +
+
+
Overrides:
+
inputStreamCharset in class ParserBuilder
+
Parameters:
+
value - The new value for this property.
+
Returns:
+
This object (for method chaining).
+
See Also:
+
ParserContext.PARSER_inputStreamCharset
+
+

+ + + +

+
fileCharset
+
```
public MsgPackParserBuilder fileCharset(String value)
```
+
Description copied from class: ParserBuilder
+
Configuration property: File charset. +
+
- Name: "Parser.fileCharset" +
- Data type: String +
- Default: "default" +
- Session-overridable: true +
+
+ The character set to use for reading Files from the file system. +
+ Used when passing in files to Parser.parse(Object, Class). +
+ "default" can be used to indicate the JVM default file system charset. +
+
Notes:
+
- This is equivalent to calling property(PARSER_fileCharset,value). +
+
+
Overrides:
+
fileCharset in class ParserBuilder
+
Parameters:
+
value - The new value for this property.
+
Returns:
+
This object (for method chaining).
+
See Also:
+
ParserContext.PARSER_fileCharset
+
+

+ + + +

+
beansRequireDefaultConstructor
+
```
public MsgPackParserBuilder beansRequireDefaultConstructor(boolean value)
```
+
Description copied from class: CoreObjectBuilder
+
Configuration property: Beans require no-arg constructors. +
+
- Name: "BeanContext.beansRequireDefaultConstructor" +
- Data type: Boolean +
- Default: false +
- Session-overridable: false +
+
+ If true, a Java class must implement a default no-arg constructor to be considered a bean. + Otherwise, the bean will be serialized as a string using the Object.toString() method. +
+ The @Bean annotation can be used on a class to override this setting when true. +
+
Notes:
+
- This is equivalent to calling property(BEAN_beansRequireDefaultConstructor, value). +
+
+
Overrides:
+
beansRequireDefaultConstructor in class ParserBuilder
+
Parameters:
+
value - The new value for this property.
+
Returns:
+
This object (for method chaining).
+
See Also:
+
BeanContext.BEAN_beansRequireDefaultConstructor
+
+

+ + + +

+
beansRequireSerializable
+
```
public MsgPackParserBuilder beansRequireSerializable(boolean value)
```
+
Description copied from class: CoreObjectBuilder
+
Configuration property: Beans require Serializable interface. +
+
- Name: "BeanContext.beansRequireSerializable" +
- Data type: Boolean +
- Default: false +
- Session-overridable: false +
+
+ If true, a Java class must implement the Serializable interface to be considered a bean. + Otherwise, the bean will be serialized as a string using the Object.toString() method. +
+ The @Bean annotation can be used on a class to override this setting when true. +
+
Notes:
+
- This is equivalent to calling property(BEAN_beansRequireSerializable, value). +
+
+
Overrides:
+
beansRequireSerializable in class ParserBuilder
+
Parameters:
+
value - The new value for this property.
+
Returns:
+
This object (for method chaining).
+
See Also:
+
BeanContext.BEAN_beansRequireSerializable
+
+

+ + + +

+
beansRequireSettersForGetters
+
```
public MsgPackParserBuilder beansRequireSettersForGetters(boolean value)
```
+
Description copied from class: CoreObjectBuilder
+
Configuration property: Beans require setters for getters. +
+
- Name: "BeanContext.beansRequireSettersForGetters" +
- Data type: Boolean +
- Default: false +
- Session-overridable: false +
+
+ If true, only getters that have equivalent setters will be considered as properties on a bean. + Otherwise, they will be ignored. +
+
Notes:
+
- This is equivalent to calling property(BEAN_beansRequireSettersForGetters, value). +
+
+
Overrides:
+
beansRequireSettersForGetters in class ParserBuilder
+
Parameters:
+
value - The new value for this property.
+
Returns:
+
This object (for method chaining).
+
See Also:
+
BeanContext.BEAN_beansRequireSettersForGetters
+
+

+ + + +

+
beansRequireSomeProperties
+
```
public MsgPackParserBuilder beansRequireSomeProperties(boolean value)
```
+
Description copied from class: CoreObjectBuilder
+
Configuration property: Beans require at least one property. +
+
- Name: "BeanContext.beansRequireSomeProperties" +
- Data type: Boolean +
- Default: true +
- Session-overridable: false +
+
+ If true, then a Java class must contain at least 1 property to be considered a bean. + Otherwise, the bean will be serialized as a string using the Object.toString() method. +
+ The @Bean annotation can be used on a class to override this setting when true. +
+
Notes:
+
- This is equivalent to calling property(BEAN_beansRequireSomeProperties, value). +
+
+
Overrides:
+
beansRequireSomeProperties in class ParserBuilder
+
Parameters:
+
value - The new value for this property.
+
Returns:
+
This object (for method chaining).
+
See Also:
+
BeanContext.BEAN_beansRequireSomeProperties
+
+

+ + + +

+
beanMapPutReturnsOldValue
+
```
public MsgPackParserBuilder beanMapPutReturnsOldValue(boolean value)
```
+
Description copied from class: CoreObjectBuilder
+
Configuration property: BeanMap.put() method will return old property value. +
+
- Name: "BeanContext.beanMapPutReturnsOldValue" +
- Data type: Boolean +
- Default: false +
- Session-overridable: false +
+
+ If true, then the BeanMap.put() method will return old property values. + Otherwise, it returns null. +
+ Disabled by default because it introduces a slight performance penalty. +
+
Notes:
+
- This is equivalent to calling property(BEAN_beanMapPutReturnsOldValue, value). +
+
+
Overrides:
+
beanMapPutReturnsOldValue in class ParserBuilder
+
Parameters:
+
value - The new value for this property.
+
Returns:
+
This object (for method chaining).
+
See Also:
+
BeanContext.BEAN_beanMapPutReturnsOldValue
+
+

+ + + +

+
beanConstructorVisibility
+
```
public MsgPackParserBuilder beanConstructorVisibility(Visibility value)
```
+
Description copied from class: CoreObjectBuilder
+
Configuration property: Look for bean constructors with the specified minimum visibility. +
+
- Name: "BeanContext.beanConstructorVisibility" +
- Data type: Visibility +
- Default: Visibility.PUBLIC +
- Session-overridable: false +
+
+ Constructors not meeting this minimum visibility will be ignored. + For example, if the visibility is PUBLIC and the constructor is protected, then + the constructor will be ignored. +
+
Notes:
+
- This is equivalent to calling property(BEAN_beanConstructorVisibility, value). +
+
+
Overrides:
+
beanConstructorVisibility in class ParserBuilder
+
Parameters:
+
value - The new value for this property.
+
Returns:
+
This object (for method chaining).
+
See Also:
+
BeanContext.BEAN_beanConstructorVisibility
+
+

+ + + +

+
beanClassVisibility
+
```
public MsgPackPar
```

Class MsgPackParserBuilder

Field Summary

Fields inherited from class org.apache.juneau.CoreObjectBuilder

Constructor Summary

Method Summary

Methods inherited from class org.apache.juneau.CoreObjectBuilder

Methods inherited from class java.lang.Object

Constructor Detail

MsgPackParserBuilder

MsgPackParserBuilder

Method Detail

build

trimStrings

Notes:

strict

Notes:

strict

inputStreamCharset

Notes:

fileCharset

Notes:

beansRequireDefaultConstructor

Notes:

beansRequireSerializable

Notes:

beansRequireSettersForGetters

Notes:

beansRequireSomeProperties

Notes:

beanMapPutReturnsOldValue

Notes:

beanConstructorVisibility

Notes:

beanClassVisibility