public class InputStreamParserBuilder extends ParserBuilder
psb
Constructor and Description |
---|
InputStreamParserBuilder()
Constructor, default settings.
|
InputStreamParserBuilder(PropertyStore ps)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
InputStreamParserBuilder |
add(Map<String,Object> properties)
Adds multiple configuration properties on this object.
|
InputStreamParserBuilder |
addTo(String name,
Object value)
Adds a value to a SET or LIST property.
|
InputStreamParserBuilder |
addTo(String name,
String key,
Object value)
Adds or overwrites a value to a SET, LIST, or MAP property.
|
InputStreamParserBuilder |
annotations(Annotation... values)
Configuration property: Annotations.
|
InputStreamParserBuilder |
apply(PropertyStore copyFrom)
Copies the settings from the specified property store into this builder.
|
InputStreamParserBuilder |
applyAnnotations(AnnotationList al,
VarResolverSession vrs)
Applies a set of annotations to this property store.
|
InputStreamParserBuilder |
applyAnnotations(Class<?>... fromClasses)
Applies any of the various
|
InputStreamParserBuilder |
applyAnnotations(Method... fromMethods)
Applies any of the various
|
InputStreamParserBuilder |
autoCloseStreams()
Configuration property: Auto-close streams.
|
InputStreamParserBuilder |
autoCloseStreams(boolean value)
Configuration property: Auto-close streams.
|
InputStreamParserBuilder |
beanClassVisibility(Visibility value)
Configuration property: Minimum bean class visibility.
|
InputStreamParserBuilder |
beanConstructorVisibility(Visibility value)
Configuration property: Minimum bean constructor visibility.
|
InputStreamParserBuilder |
beanDictionary(Class<?>... values)
Deprecated.
|
InputStreamParserBuilder |
beanDictionary(Object... values)
Deprecated.
|
InputStreamParserBuilder |
beanDictionaryRemove(Class<?>... values)
Deprecated.
|
InputStreamParserBuilder |
beanDictionaryRemove(Object... values)
Deprecated.
|
InputStreamParserBuilder |
beanDictionaryReplace(Class<?>... values)
Deprecated.
|
InputStreamParserBuilder |
beanDictionaryReplace(Object... values)
Deprecated.
|
InputStreamParserBuilder |
beanFieldVisibility(Visibility value)
Configuration property: Minimum bean field visibility.
|
InputStreamParserBuilder |
beanFilters(Class<?>... values)
Configuration property: Bean filters.
|
InputStreamParserBuilder |
beanFilters(Object... values)
Configuration property: Bean filters.
|
InputStreamParserBuilder |
beanFiltersRemove(Class<?>... values)
Configuration property: Bean filters.
|
InputStreamParserBuilder |
beanFiltersRemove(Object... values)
Configuration property: Bean filters.
|
InputStreamParserBuilder |
beanFiltersReplace(Class<?>... values)
Configuration property: Bean filters.
|
InputStreamParserBuilder |
beanFiltersReplace(Object... values)
Configuration property: Bean filters.
|
InputStreamParserBuilder |
beanMapPutReturnsOldValue()
Configuration property: BeanMap.put() returns old property value.
|
InputStreamParserBuilder |
beanMapPutReturnsOldValue(boolean value)
Configuration property: BeanMap.put() returns old property value.
|
InputStreamParserBuilder |
beanMethodVisibility(Visibility value)
Configuration property: Minimum bean method visibility.
|
InputStreamParserBuilder |
beansRequireDefaultConstructor()
Configuration property: Beans require no-arg constructors.
|
InputStreamParserBuilder |
beansRequireDefaultConstructor(boolean value)
Configuration property: Beans require no-arg constructors.
|
InputStreamParserBuilder |
beansRequireSerializable()
Configuration property: Beans require Serializable interface.
|
InputStreamParserBuilder |
beansRequireSerializable(boolean value)
Configuration property: Beans require Serializable interface.
|
InputStreamParserBuilder |
beansRequireSettersForGetters()
Configuration property: Beans require setters for getters.
|
InputStreamParserBuilder |
beansRequireSettersForGetters(boolean value)
Configuration property: Beans require setters for getters.
|
InputStreamParserBuilder |
beansRequireSomeProperties(boolean value)
Configuration property: Beans require at least one property.
|
InputStreamParserBuilder |
beanTypePropertyName(String value)
Configuration property: Bean type property name.
|
InputStreamParserBuilder |
binaryFormat(BinaryFormat value)
Configuration property: Binary input format.
|
InputStreamParserBuilder |
binaryFormat(String value)
Configuration property: Binary input format.
|
InputStreamParserBuilder |
bpi(Class<?> beanClass,
String value)
Configuration property: Bean property includes.
|
InputStreamParserBuilder |
bpi(Map<String,String> values)
Configuration property: Bean property includes.
|
InputStreamParserBuilder |
bpi(String beanClassName,
String value)
Configuration property: Bean property includes.
|
InputStreamParserBuilder |
bpro(Class<?> beanClass,
String value)
Configuration property: Read-only bean properties.
|
InputStreamParserBuilder |
bpro(Map<String,String> values)
Configuration property: Read-only bean properties.
|
InputStreamParserBuilder |
bpro(String beanClassName,
String value)
Configuration property: Read-only bean properties.
|
InputStreamParserBuilder |
bpwo(Class<?> beanClass,
String properties)
Configuration property: Write-only bean properties.
|
InputStreamParserBuilder |
bpwo(Map<String,String> values)
Configuration property: Write-only bean properties.
|
InputStreamParserBuilder |
bpwo(String beanClassName,
String value)
Configuration property: Write-only bean properties.
|
InputStreamParserBuilder |
bpx(Class<?> beanClass,
String properties)
Configuration property: Bean property excludes.
|
InputStreamParserBuilder |
bpx(Map<String,String> values)
Configuration property: Bean property excludes.
|
InputStreamParserBuilder |
bpx(String beanClassName,
String value)
Configuration property: Bean property excludes.
|
InputStreamParser |
build()
Build the object.
|
InputStreamParserBuilder |
debug()
Configuration property: Debug mode.
|
InputStreamParserBuilder |
debugOutputLines(int value)
Configuration property: Debug output lines.
|
InputStreamParserBuilder |
dictionary(Class<?>... values)
Configuration property: Bean dictionary.
|
InputStreamParserBuilder |
dictionary(Object... values)
Configuration property: Bean dictionary.
|
InputStreamParserBuilder |
dictionaryRemove(Class<?>... values)
Configuration property: Bean dictionary.
|
InputStreamParserBuilder |
dictionaryRemove(Object... values)
Configuration property: Bean dictionary.
|
InputStreamParserBuilder |
dictionaryReplace(Class<?>... values)
Configuration property: Bean dictionary.
|
InputStreamParserBuilder |
dictionaryReplace(Object... values)
Configuration property: Bean dictionary.
|
<T> InputStreamParserBuilder |
example(Class<T> c,
T o)
Configuration property: POJO example.
|
<T> InputStreamParserBuilder |
exampleJson(Class<T> c,
String value)
Configuration property: POJO example.
|
InputStreamParserBuilder |
ignoreInvocationExceptionsOnGetters()
Configuration property: Ignore invocation errors on getters.
|
InputStreamParserBuilder |
ignoreInvocationExceptionsOnGetters(boolean value)
Configuration property: Ignore invocation errors on getters.
|
InputStreamParserBuilder |
ignoreInvocationExceptionsOnSetters()
Configuration property: Ignore invocation errors on setters.
|
InputStreamParserBuilder |
ignoreInvocationExceptionsOnSetters(boolean value)
Configuration property: Ignore invocation errors on setters.
|
InputStreamParserBuilder |
ignorePropertiesWithoutSetters(boolean value)
Configuration property: Ignore properties without setters.
|
InputStreamParserBuilder |
ignoreUnknownBeanProperties()
Configuration property: Ignore unknown properties.
|
InputStreamParserBuilder |
ignoreUnknownBeanProperties(boolean value)
Configuration property: Ignore unknown properties.
|
InputStreamParserBuilder |
ignoreUnknownNullBeanProperties(boolean value)
Configuration property: Ignore unknown properties with null values.
|
InputStreamParserBuilder |
implClass(Class<?> interfaceClass,
Class<?> implClass)
Configuration property: Implementation classes.
|
InputStreamParserBuilder |
implClasses(Map<String,Class<?>> values)
Configuration property: Implementation classes.
|
InputStreamParserBuilder |
listener(Class<? extends ParserListener> value)
Configuration property: Parser listener.
|
InputStreamParserBuilder |
locale(Locale value)
Configuration property: Locale.
|
InputStreamParserBuilder |
mediaType(MediaType value)
Configuration property: Media type.
|
InputStreamParserBuilder |
notBeanClasses(Class<?>... values)
Configuration property: Bean class exclusions.
|
InputStreamParserBuilder |
notBeanClasses(Object... values)
Configuration property: Bean class exclusions.
|
InputStreamParserBuilder |
notBeanClassesRemove(Class<?>... values)
Configuration property: Bean class exclusions.
|
InputStreamParserBuilder |
notBeanClassesRemove(Object... values)
Configuration property: Bean class exclusions.
|
InputStreamParserBuilder |
notBeanClassesReplace(Class<?>... values)
Configuration property: Bean class exclusions.
|
InputStreamParserBuilder |
notBeanClassesReplace(Object... values)
Configuration property: Bean class exclusions.
|
InputStreamParserBuilder |
notBeanPackages(Object... values)
Configuration property: Bean package exclusions.
|
InputStreamParserBuilder |
notBeanPackages(String... values)
Configuration property: Bean package exclusions.
|
InputStreamParserBuilder |
notBeanPackagesRemove(Object... values)
Configuration property: Bean package exclusions.
|
InputStreamParserBuilder |
notBeanPackagesRemove(String... values)
Configuration property: Bean package exclusions.
|
InputStreamParserBuilder |
notBeanPackagesReplace(Object... values)
Configuration property: Bean package exclusions.
|
InputStreamParserBuilder |
notBeanPackagesReplace(String... values)
Configuration property: Bean package exclusions.
|
InputStreamParserBuilder |
pojoSwaps(Class<?>... values)
Configuration property: POJO swaps.
|
InputStreamParserBuilder |
pojoSwaps(Object... values)
Configuration property: POJO swaps.
|
InputStreamParserBuilder |
pojoSwapsRemove(Class<?>... values)
Configuration property: POJO swaps.
|
InputStreamParserBuilder |
pojoSwapsRemove(Object... values)
Configuration property: POJO swaps.
|
InputStreamParserBuilder |
pojoSwapsReplace(Class<?>... values)
Configuration property: POJO swaps.
|
InputStreamParserBuilder |
pojoSwapsReplace(Object... values)
Configuration property: POJO swaps.
|
InputStreamParserBuilder |
removeFrom(String name,
Object value)
Removes a value from a SET, LIST, or MAP property.
|
InputStreamParserBuilder |
set(Map<String,Object> properties)
Sets multiple configuration properties on this object.
|
InputStreamParserBuilder |
set(String name,
Object value)
Sets a configuration property on this object.
|
InputStreamParserBuilder |
sortProperties()
Configuration property: Sort bean properties.
|
InputStreamParserBuilder |
sortProperties(boolean value)
Configuration property: Sort bean properties.
|
InputStreamParserBuilder |
strict()
Configuration property: Strict mode.
|
InputStreamParserBuilder |
strict(boolean value)
Configuration property: Strict mode.
|
InputStreamParserBuilder |
timeZone(TimeZone value)
Configuration property: TimeZone.
|
InputStreamParserBuilder |
trimStrings()
Configuration property: Trim parsed strings.
|
InputStreamParserBuilder |
trimStrings(boolean value)
Configuration property: Trim parsed strings.
|
InputStreamParserBuilder |
unbuffered()
Configuration property: Unbuffered.
|
InputStreamParserBuilder |
unbuffered(boolean value)
Configuration property: Unbuffered.
|
InputStreamParserBuilder |
useEnumNames()
Configuration property: Use enum names.
|
InputStreamParserBuilder |
useEnumNames(boolean value)
Configuration property: Use enum names.
|
InputStreamParserBuilder |
useInterfaceProxies(boolean value)
Configuration property: Use interface proxies.
|
InputStreamParserBuilder |
useJavaBeanIntrospector()
Configuration property: Use Java Introspector.
|
InputStreamParserBuilder |
useJavaBeanIntrospector(boolean value)
Configuration property: Use Java Introspector.
|
debug, examples, excludeProperties, excludeProperties, excludeProperties, fluentSetters, fluentSetters, includeProperties, includeProperties, includeProperties, propertyNamer
build, getPropertyStore, getPropertyStoreBuilder, peek, peek
public InputStreamParserBuilder()
public InputStreamParserBuilder(PropertyStore ps)
ps
- The initial configuration settings for this builder.public InputStreamParserBuilder binaryFormat(BinaryFormat value)
When using the Parser.parse(Object,Class)
method on stream-based parsers and the input is a string, this defines the format to use
when converting the string into a byte array.
value
- The new value for this property.
BinaryFormat.HEX
.public InputStreamParserBuilder binaryFormat(String value)
When using the Parser.parse(Object,Class)
method on stream-based parsers and the input is a string, this defines the format to use
when converting the string into a byte array.
value
- The new value for this property.
BinaryFormat.HEX
.public InputStreamParserBuilder autoCloseStreams(boolean value)
ParserBuilder
If
autoCloseStreams
in class ParserBuilder
value
- The new value for this property.
public InputStreamParserBuilder autoCloseStreams()
ParserBuilder
Shortcut for calling autoCloseStreams(
.
autoCloseStreams
in class ParserBuilder
public InputStreamParserBuilder debugOutputLines(int value)
ParserBuilder
When parse errors occur, this specifies the number of lines of input before and after the error location to be printed as part of the exception message.
debugOutputLines
in class ParserBuilder
value
- The new value for this property.
public InputStreamParserBuilder listener(Class<? extends ParserListener> value)
ParserBuilder
Class used to listen for errors and warnings that occur during parsing.
listener
in class ParserBuilder
value
- The new value for this property.public InputStreamParserBuilder strict(boolean value)
ParserBuilder
If
strict
in class ParserBuilder
value
- The new value for this property.
public InputStreamParserBuilder strict()
ParserBuilder
Shortcut for calling strict(
.
strict
in class ParserBuilder
public InputStreamParserBuilder trimStrings(boolean value)
ParserBuilder
If String.trim()
before being added to
the POJO.
trimStrings
in class ParserBuilder
value
- The new value for this property.
public InputStreamParserBuilder trimStrings()
ParserBuilder
Shortcut for calling trimStrings(
.
trimStrings
in class ParserBuilder
public InputStreamParserBuilder unbuffered(boolean value)
ParserBuilder
If
unbuffered
in class ParserBuilder
value
- The new value for this property.
public InputStreamParserBuilder unbuffered()
ParserBuilder
Shortcut for calling unbuffered(
.
unbuffered
in class ParserBuilder
public InputStreamParserBuilder annotations(Annotation... values)
BeanContextBuilder
Defines annotations to apply to specific classes and methods.
Allows you to dynamically apply Juneau annotations typically applied directly to classes and methods. Useful in cases where you want to use the functionality of the annotation on beans and bean properties but do not have access to the code to do so.
annotations
in class ParserBuilder
values
- The values to add to this property.public InputStreamParserBuilder beanClassVisibility(Visibility value)
BeanContextBuilder
Classes are not considered beans unless they meet the minimum visibility requirements.
For example, if the visibility is
beanClassVisibility
in class ParserBuilder
value
- The new value for this property.
Visibility.PUBLIC
.public InputStreamParserBuilder beanConstructorVisibility(Visibility value)
BeanContextBuilder
Only look for constructors with the specified minimum visibility.
beanConstructorVisibility
in class ParserBuilder
value
- The new value for this property.
Visibility.PUBLIC
.@Deprecated public InputStreamParserBuilder beanDictionary(Class<?>... values)
BeanContextBuilder
BeanContextBuilder.dictionary(Class...)
Same as BeanContextBuilder.beanDictionary(Object...)
but takes in an array of classes.
beanDictionary
in class ParserBuilder
values
- The values to add to this property.@Deprecated public InputStreamParserBuilder beanDictionary(Object... values)
BeanContextBuilder
BeanContextBuilder.dictionary(Object...)
Adds to the list of classes that make up the bean dictionary in this bean context.
beanDictionary
in class ParserBuilder
values
- The values to add to this property.@Deprecated public InputStreamParserBuilder beanDictionaryReplace(Class<?>... values)
BeanContextBuilder
BeanContextBuilder.dictionaryReplace(Class...)
Same as BeanContextBuilder.beanDictionary(Object...)
but replaces the existing value.
beanDictionaryReplace
in class ParserBuilder
values
- The new values for this property.@Deprecated public InputStreamParserBuilder beanDictionaryReplace(Object... values)
BeanContextBuilder
BeanContextBuilder.dictionaryReplace(Object...)
Same as BeanContextBuilder.beanDictionary(Object...)
but replaces the existing value.
beanDictionaryReplace
in class ParserBuilder
values
- The new values for this property.@Deprecated public InputStreamParserBuilder beanDictionaryRemove(Class<?>... values)
BeanContextBuilder
BeanContextBuilder.dictionaryRemove(Class...)
Removes from the list of classes that make up the bean dictionary in this bean context.
beanDictionaryRemove
in class ParserBuilder
values
- The values to remove from this property.@Deprecated public InputStreamParserBuilder beanDictionaryRemove(Object... values)
BeanContextBuilder
BeanContextBuilder.dictionaryRemove(Object...)
Removes from the list of classes that make up the bean dictionary in this bean context.
beanDictionaryRemove
in class ParserBuilder
values
- The values to remove from this property.public InputStreamParserBuilder beanFieldVisibility(Visibility value)
BeanContextBuilder
Only look for bean fields with the specified minimum visibility.
beanFieldVisibility
in class ParserBuilder
value
- The new value for this property.
Visibility.PUBLIC
.public InputStreamParserBuilder beanFilters(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...)
but takes in an array of classes.
beanFilters
in class ParserBuilder
values
- The values to add to this property.public InputStreamParserBuilder beanFilters(Object... values)
BeanContextBuilder
This is a programmatic equivalent to the @Bean
annotation.
It's useful when you want to use the Bean annotation functionality, but you don't have the ability to alter
the bean classes.
beanFilters
in class ParserBuilder
values
- The values to add to this property.
@Bean(typeName)
.
BeanDictionaryList
containing a collection of bean classes with type name annotations.
BeanDictionaryMap
containing a mapping of type names to classes without type name annotations.
public InputStreamParserBuilder beanFiltersReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...)
but replaces the existing values.
beanFiltersReplace
in class ParserBuilder
values
- The new values for this property.
@Bean(typeName)
.
BeanDictionaryList
containing a collection of bean classes with type name annotations.
BeanDictionaryMap
containing a mapping of type names to classes without type name annotations.
public InputStreamParserBuilder beanFiltersReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...)
but replaces the existing values.
beanFiltersReplace
in class ParserBuilder
values
- The new values for this property.
@Bean(typeName)
.
BeanDictionaryList
containing a collection of bean classes with type name annotations.
BeanDictionaryMap
containing a mapping of type names to classes without type name annotations.
public InputStreamParserBuilder beanFiltersRemove(Class<?>... values)
BeanContextBuilder
Removes from the list of classes that make up the bean filters in this bean context.
beanFiltersRemove
in class ParserBuilder
values
- The values to remove from this property.
@Bean(typeName)
.
BeanDictionaryList
containing a collection of bean classes with type name annotations.
BeanDictionaryMap
containing a mapping of type names to classes without type name annotations.
public InputStreamParserBuilder beanFiltersRemove(Object... values)
BeanContextBuilder
Removes from the list of classes that make up the bean filters in this bean context.
beanFiltersRemove
in class ParserBuilder
values
- The values to remove from this property.
@Bean(typeName)
.
BeanDictionaryList
containing a collection of bean classes with type name annotations.
BeanDictionaryMap
containing a mapping of type names to classes without type name annotations.
public InputStreamParserBuilder beanMapPutReturnsOldValue(boolean value)
BeanContextBuilder
If BeanMap.put()
method will return old property
values.
Otherwise, it returns
beanMapPutReturnsOldValue
in class ParserBuilder
value
- The new value for this property.
public InputStreamParserBuilder beanMapPutReturnsOldValue()
BeanContextBuilder
Shortcut for calling beanMapPutReturnsOldValue(
.
beanMapPutReturnsOldValue
in class ParserBuilder
public InputStreamParserBuilder beanMethodVisibility(Visibility value)
BeanContextBuilder
Only look for bean methods with the specified minimum visibility.
beanMethodVisibility
in class ParserBuilder
value
- The new value for this property.
Visibility.PUBLIC
public InputStreamParserBuilder beansRequireDefaultConstructor(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString()
method.
beansRequireDefaultConstructor
in class ParserBuilder
value
- The new value for this property.
public InputStreamParserBuilder beansRequireDefaultConstructor()
BeanContextBuilder
Shortcut for calling beansRequireDefaultConstructor(
.
beansRequireDefaultConstructor
in class ParserBuilder
public InputStreamParserBuilder beansRequireSerializable(boolean value)
BeanContextBuilder
If Serializable
interface to be considered a bean.
Otherwise, the bean will be serialized as a string using the Object.toString()
method.
beansRequireSerializable
in class ParserBuilder
value
- The new value for this property.
public InputStreamParserBuilder beansRequireSerializable()
BeanContextBuilder
Shortcut for calling beansRequireSerializable(
.
beansRequireSerializable
in class ParserBuilder
public InputStreamParserBuilder beansRequireSettersForGetters(boolean value)
BeanContextBuilder
If
Otherwise, they will be ignored.
beansRequireSettersForGetters
in class ParserBuilder
value
- The new value for this property.
public InputStreamParserBuilder beansRequireSettersForGetters()
BeanContextBuilder
Shortcut for calling beansRequireSettersForGetters(
.
beansRequireSettersForGetters
in class ParserBuilder
public InputStreamParserBuilder beansRequireSomeProperties(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString()
method.
beansRequireSomeProperties
in class ParserBuilder
value
- The new value for this property.
public InputStreamParserBuilder beanTypePropertyName(String value)
BeanContextBuilder
This specifies the name of the bean property used to store the dictionary name of a bean type so that the parser knows the data type to reconstruct.
beanTypePropertyName
in class ParserBuilder
value
- The new value for this property.
public InputStreamParserBuilder bpi(Class<?> beanClass, String value)
BeanContextBuilder
Specifies the set and order of names of properties associated with the bean class.
bpi
in class ParserBuilder
beanClass
- The bean class.value
- Comma-delimited list of property names.public InputStreamParserBuilder bpi(Map<String,String> values)
BeanContextBuilder
Specifies the set and order of names of properties associated with the bean class.
bpi
in class ParserBuilder
values
- The new value for this property.public InputStreamParserBuilder bpi(String beanClassName, String value)
BeanContextBuilder
Specifies the set and order of names of properties associated with the bean class.
bpi
in class ParserBuilder
beanClassName
- The bean class name.
value
- Comma-delimited list of property names.public InputStreamParserBuilder bpx(Class<?> beanClass, String properties)
BeanContextBuilder
Specifies to exclude the specified list of properties for the specified bean class.
bpx
in class ParserBuilder
beanClass
- The bean class.properties
- Comma-delimited list of property names.public InputStreamParserBuilder bpx(Map<String,String> values)
BeanContextBuilder
Specifies to exclude the specified list of properties for the specified bean classes.
bpx
in class ParserBuilder
values
- The new value for this property.public InputStreamParserBuilder bpx(String beanClassName, String value)
BeanContextBuilder
bpx
in class ParserBuilder
beanClassName
- The bean class name.
value
- Comma-delimited list of property names.public InputStreamParserBuilder bpro(Class<?> beanClass, String value)
BeanContextBuilder
Specifies the read-only properties for the specified bean class.
bpro
in class ParserBuilder
beanClass
- The bean class.value
- Comma-delimited list of property names.public InputStreamParserBuilder bpro(Map<String,String> values)
BeanContextBuilder
Specifies the read-only properties for the specified bean classes.
bpro
in class ParserBuilder
values
- The new value for this property.public InputStreamParserBuilder bpro(String beanClassName, String value)
BeanContextBuilder
Specifies the read-only properties for the specified bean class.
bpro
in class ParserBuilder
beanClassName
- The bean class name.
value
- Comma-delimited list of property names.public InputStreamParserBuilder bpwo(Class<?> beanClass, String properties)
BeanContextBuilder
Specifies the write-only properties for the specified bean class.
bpwo
in class ParserBuilder
beanClass
- The bean class.properties
- Comma-delimited list of property names.public InputStreamParserBuilder bpwo(Map<String,String> values)
BeanContextBuilder
Specifies the write-only properties for the specified bean classes.
bpwo
in class ParserBuilder
values
- The new value for this property.public InputStreamParserBuilder bpwo(String beanClassName, String value)
BeanContextBuilder
Specifies the write-only properties for the specified bean class.
bpwo
in class ParserBuilder
beanClassName
- The bean class name.
value
- Comma-delimited list of property names.public InputStreamParserBuilder debug()
BeanContextBuilder
Shortcut for calling debug(
.
debug
in class ParserBuilder
public InputStreamParserBuilder dictionary(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...)
but takes in an array of classes.
dictionary
in class ParserBuilder
values
- The values to add to this property.public InputStreamParserBuilder dictionary(Object... values)
BeanContextBuilder
Adds to the list of classes that make up the bean dictionary in this bean context.
dictionary
in class ParserBuilder
values
- The values to add to this property.public InputStreamParserBuilder dictionaryReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...)
but replaces the existing value.
dictionaryReplace
in class ParserBuilder
values
- The new values for this property.public InputStreamParserBuilder dictionaryReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...)
but replaces the existing value.
dictionaryReplace
in class ParserBuilder
values
- The new values for this property.public InputStreamParserBuilder dictionaryRemove(Class<?>... values)
BeanContextBuilder
Removes from the list of classes that make up the bean dictionary in this bean context.
dictionaryRemove
in class ParserBuilder
values
- The values to remove from this property.public InputStreamParserBuilder dictionaryRemove(Object... values)
BeanContextBuilder
Removes from the list of classes that make up the bean dictionary in this bean context.
dictionaryRemove
in class ParserBuilder
values
- The values to remove from this property.public <T> InputStreamParserBuilder example(Class<T> c, T o)
BeanContextBuilder
Specifies an example of the specified class.
example
in class ParserBuilder
c
- The POJO class.o
- An instance of the POJO class used for examples.public <T> InputStreamParserBuilder exampleJson(Class<T> c, String value)
BeanContextBuilder
Specifies an example of the specified class.
exampleJson
in class ParserBuilder
T
- The POJO class type.c
- The POJO class.value
- The simple JSON representation of the example.public InputStreamParserBuilder ignoreInvocationExceptionsOnGetters(boolean value)
BeanContextBuilder
If BeanRuntimeException
is thrown.
ignoreInvocationExceptionsOnGetters
in class ParserBuilder
value
- The new value for this property.
public InputStreamParserBuilder ignoreInvocationExceptionsOnGetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnGetters(
.
ignoreInvocationExceptionsOnGetters
in class ParserBuilder
public InputStreamParserBuilder ignoreInvocationExceptionsOnSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreInvocationExceptionsOnSetters
in class ParserBuilder
value
- The new value for this property.
public InputStreamParserBuilder ignoreInvocationExceptionsOnSetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnSetters(
.
ignoreInvocationExceptionsOnSetters
in class ParserBuilder
public InputStreamParserBuilder ignorePropertiesWithoutSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignorePropertiesWithoutSetters
in class ParserBuilder
value
- The new value for this property.
public InputStreamParserBuilder ignoreUnknownBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreUnknownBeanProperties
in class ParserBuilder
value
- The new value for this property.
public InputStreamParserBuilder ignoreUnknownBeanProperties()
BeanContextBuilder
Shortcut for calling ignoreUnknownBeanProperties(
.
ignoreUnknownBeanProperties
in class ParserBuilder
public InputStreamParserBuilder ignoreUnknownNullBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreUnknownNullBeanProperties
in class ParserBuilder
value
- The new value for this property.
public InputStreamParserBuilder implClass(Class<?> interfaceClass, Class<?> implClass)
BeanContextBuilder
implClass
in class ParserBuilder
interfaceClass
- The interface class.implClass
- The implementation class.public InputStreamParserBuilder implClasses(Map<String,Class<?>> values)
BeanContextBuilder
For interfaces and abstract classes this method can be used to specify an implementation class for the interface/abstract class so that instances of the implementation class are used when instantiated (e.g. during a parse).
implClasses
in class ParserBuilder
values
- The new value for this property.public InputStreamParserBuilder locale(Locale value)
BeanContextBuilder
Specifies a default locale for serializer and parser sessions.
locale
in class ParserBuilder
value
- The new value for this property.public InputStreamParserBuilder mediaType(MediaType value)
BeanContextBuilder
Specifies a default media type value for serializer and parser sessions.
mediaType
in class ParserBuilder
value
- The new value for this property.public InputStreamParserBuilder notBeanClasses(Class<?>... values)
BeanContextBuilder
List of classes that should not be treated as beans even if they appear to be bean-like.
Not-bean classes are converted to
notBeanClasses
in class ParserBuilder
values
- The values to add to this property.public InputStreamParserBuilder notBeanClasses(Object... values)
BeanContextBuilder
List of classes that should not be treated as beans even if they appear to be bean-like.
Not-bean classes are converted to
notBeanClasses
in class ParserBuilder
values
- The values to add to this property.
public InputStreamParserBuilder notBeanClassesReplace(Class<?>... values)
BeanContextBuilder
Not-bean classes are converted to
notBeanClassesReplace
in class ParserBuilder
values
- The new value for this property.public InputStreamParserBuilder notBeanClassesReplace(Object... values)
BeanContextBuilder
Not-bean classes are converted to
notBeanClassesReplace
in class ParserBuilder
values
- The new value for this property.
public InputStreamParserBuilder notBeanClassesRemove(Class<?>... values)
BeanContextBuilder
notBeanClassesRemove
in class ParserBuilder
values
- The values to remove from this property.public InputStreamParserBuilder notBeanClassesRemove(Object... values)
BeanContextBuilder
notBeanClassesRemove
in class ParserBuilder
values
- The values to remove from this property.
public InputStreamParserBuilder notBeanPackages(Object... values)
BeanContextBuilder
notBeanPackages
in class ParserBuilder
values
- The values to add to this property.
public InputStreamParserBuilder notBeanPackages(String... values)
BeanContextBuilder
notBeanPackages
in class ParserBuilder
values
- The values to add to this property.public InputStreamParserBuilder notBeanPackagesReplace(String... values)
BeanContextBuilder
notBeanPackagesReplace
in class ParserBuilder
values
- public InputStreamParserBuilder notBeanPackagesReplace(Object... values)
BeanContextBuilder
notBeanPackagesReplace
in class ParserBuilder
values
- public InputStreamParserBuilder notBeanPackagesRemove(String... values)
BeanContextBuilder
notBeanPackagesRemove
in class ParserBuilder
values
- The values to remove from this property.public InputStreamParserBuilder notBeanPackagesRemove(Object... values)
BeanContextBuilder
notBeanPackagesRemove
in class ParserBuilder
values
- public InputStreamParserBuilder pojoSwaps(Class<?>... values)
BeanContextBuilder
pojoSwaps
in class ParserBuilder
values
- The values to add to this property.public InputStreamParserBuilder pojoSwaps(Object... values)
BeanContextBuilder
pojoSwaps
in class ParserBuilder
values
- The values to add to this property.
PojoSwap
.
SurrogateSwap
.
public InputStreamParserBuilder pojoSwapsReplace(Class<?>... values)
BeanContextBuilder
pojoSwapsReplace
in class ParserBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public InputStreamParserBuilder pojoSwapsReplace(Object... values)
BeanContextBuilder
pojoSwapsReplace
in class ParserBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public InputStreamParserBuilder pojoSwapsRemove(Class<?>... values)
BeanContextBuilder
pojoSwapsRemove
in class ParserBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public InputStreamParserBuilder pojoSwapsRemove(Object... values)
BeanContextBuilder
pojoSwapsRemove
in class ParserBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public InputStreamParserBuilder sortProperties(boolean value)
BeanContextBuilder
When
sortProperties
in class ParserBuilder
value
- The new value for this property.
public InputStreamParserBuilder sortProperties()
BeanContextBuilder
Shortcut for calling sortProperties(
.
sortProperties
in class ParserBuilder
public InputStreamParserBuilder timeZone(TimeZone value)
BeanContextBuilder
timeZone
in class ParserBuilder
value
- The new value for this property.public InputStreamParserBuilder useEnumNames(boolean value)
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString()
.
useEnumNames
in class ParserBuilder
value
- The property value.public InputStreamParserBuilder useEnumNames()
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString()
.
useEnumNames
in class ParserBuilder
public InputStreamParserBuilder useInterfaceProxies(boolean value)
BeanContextBuilder
If InvocationHandler
if there is no other way of instantiating them.
useInterfaceProxies
in class ParserBuilder
value
- The new value for this property.
public InputStreamParserBuilder useJavaBeanIntrospector(boolean value)
BeanContextBuilder
Using the built-in Java bean introspector will not pick up fields or non-standard getters/setters.
@Bean
annotations will be ignored if you enable this setting.
useJavaBeanIntrospector
in class ParserBuilder
value
- The new value for this property.
public InputStreamParserBuilder useJavaBeanIntrospector()
BeanContextBuilder
Shortcut for calling useJavaBeanIntrospector(
.
useJavaBeanIntrospector
in class ParserBuilder
public InputStreamParserBuilder set(String name, Object value)
ContextBuilder
set
in class ParserBuilder
name
- The property name.value
- The property value.PropertyStoreBuilder.set(String, Object)
public InputStreamParserBuilder set(Map<String,Object> properties)
ContextBuilder
set
in class ParserBuilder
properties
- The properties to set on this class.PropertyStoreBuilder.set(java.util.Map)
public InputStreamParserBuilder add(Map<String,Object> properties)
ContextBuilder
add
in class ParserBuilder
properties
- The properties to set on this class.PropertyStoreBuilder.add(java.util.Map)
public InputStreamParserBuilder addTo(String name, Object value)
ContextBuilder
addTo
in class ParserBuilder
name
- The property name.value
- The new value to add to the SET property.public InputStreamParserBuilder addTo(String name, String key, Object value)
ContextBuilder
addTo
in class ParserBuilder
name
- The property name.key
- The property value map key.value
- The property value map value.public InputStreamParserBuilder removeFrom(String name, Object value)
ContextBuilder
removeFrom
in class ParserBuilder
name
- The property name.value
- The property value in the SET property.public InputStreamParserBuilder apply(PropertyStore copyFrom)
ContextBuilder
apply
in class ParserBuilder
copyFrom
- The factory whose settings are being copied.public InputStreamParserBuilder applyAnnotations(AnnotationList al, VarResolverSession vrs)
ContextBuilder
applyAnnotations
in class ParserBuilder
al
- The list of all annotations annotated with PropertyStoreApply
.vrs
- The string resolver for resolving variables in annotation values.public InputStreamParserBuilder applyAnnotations(Class<?>... fromClasses)
ContextBuilder
Applies any of the following annotations:
BeanConfig
CsvConfig
HtmlConfig
HtmlDocConfig
JsoConfig
JsonConfig
JsonSchemaConfig
MsgPackConfig
OpenApiConfig
ParserConfig
PlainTextConfig
SerializerConfig
SoapXmlConfig
UonConfig
UrlEncodingConfig
XmlConfig
Annotations are appended in the following order:
applyAnnotations
in class ParserBuilder
fromClasses
- The classes on which the annotations are defined.public InputStreamParserBuilder applyAnnotations(Method... fromMethods)
ContextBuilder
Applies any of the following annotations:
BeanConfig
CsvConfig
HtmlConfig
HtmlDocConfig
JsoConfig
JsonConfig
JsonSchemaConfig
MsgPackConfig
OpenApiConfig
ParserConfig
PlainTextConfig
SerializerConfig
SoapXmlConfig
UonConfig
UrlEncodingConfig
XmlConfig
Annotations are appended in the following orders:
applyAnnotations
in class ParserBuilder
fromMethods
- The methods on which the annotations are defined.public InputStreamParser build()
ContextBuilder
build
in class ParserBuilder
Copyright © 2016–2020 The Apache Software Foundation. All rights reserved.