public class JsonSchemaGeneratorBuilder extends BeanTraverseBuilder
psb
Constructor and Description |
---|
JsonSchemaGeneratorBuilder()
Constructor, default settings.
|
JsonSchemaGeneratorBuilder(PropertyStore ps)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
JsonSchemaGeneratorBuilder |
add(Map<String,Object> properties)
Adds multiple configuration properties on this object.
|
JsonSchemaGeneratorBuilder |
addDescriptionsTo(String value)
Configuration property: Add descriptions.
|
JsonSchemaGeneratorBuilder |
addExamplesTo(String value)
Configuration property: Add examples.
|
JsonSchemaGeneratorBuilder |
addTo(String name,
Object value)
Adds a value to a SET or LIST property.
|
JsonSchemaGeneratorBuilder |
addTo(String name,
String key,
Object value)
Adds or overwrites a value to a SET, LIST, or MAP property.
|
JsonSchemaGeneratorBuilder |
allowNestedDescriptions()
Configuration property: Allow nested descriptions.
|
JsonSchemaGeneratorBuilder |
allowNestedDescriptions(boolean value)
Configuration property: Allow nested descriptions.
|
JsonSchemaGeneratorBuilder |
allowNestedExamples()
Configuration property: Allow nested examples.
|
JsonSchemaGeneratorBuilder |
allowNestedExamples(boolean value)
Configuration property: Allow nested examples.
|
JsonSchemaGeneratorBuilder |
annotations(Annotation... values)
Configuration property: Annotations.
|
JsonSchemaGeneratorBuilder |
apply(PropertyStore copyFrom)
Copies the settings from the specified property store into this builder.
|
JsonSchemaGeneratorBuilder |
applyAnnotations(AnnotationList al,
VarResolverSession vrs)
Applies a set of annotations to this property store.
|
JsonSchemaGeneratorBuilder |
applyAnnotations(Class<?>... fromClasses)
Applies any of the various
|
JsonSchemaGeneratorBuilder |
applyAnnotations(Method... fromMethods)
Applies any of the various
|
JsonSchemaGeneratorBuilder |
beanClassVisibility(Visibility value)
Configuration property: Minimum bean class visibility.
|
JsonSchemaGeneratorBuilder |
beanConstructorVisibility(Visibility value)
Configuration property: Minimum bean constructor visibility.
|
JsonSchemaGeneratorBuilder |
beanDefMapper(BeanDefMapper value)
Configuration property: Bean schema definition mapper.
|
JsonSchemaGeneratorBuilder |
beanDefMapper(Class<? extends BeanDefMapper> value)
Configuration property: Schema definition mapper.
|
JsonSchemaGeneratorBuilder |
beanDictionary(Class<?>... values)
Deprecated.
|
JsonSchemaGeneratorBuilder |
beanDictionary(Object... values)
Deprecated.
|
JsonSchemaGeneratorBuilder |
beanDictionaryRemove(Class<?>... values)
Deprecated.
|
JsonSchemaGeneratorBuilder |
beanDictionaryRemove(Object... values)
Deprecated.
|
JsonSchemaGeneratorBuilder |
beanDictionaryReplace(Class<?>... values)
Deprecated.
|
JsonSchemaGeneratorBuilder |
beanDictionaryReplace(Object... values)
Deprecated.
|
JsonSchemaGeneratorBuilder |
beanFieldVisibility(Visibility value)
Configuration property: Minimum bean field visibility.
|
JsonSchemaGeneratorBuilder |
beanFilters(Class<?>... values)
Configuration property: Bean filters.
|
JsonSchemaGeneratorBuilder |
beanFilters(Object... values)
Configuration property: Bean filters.
|
JsonSchemaGeneratorBuilder |
beanFiltersRemove(Class<?>... values)
Configuration property: Bean filters.
|
JsonSchemaGeneratorBuilder |
beanFiltersRemove(Object... values)
Configuration property: Bean filters.
|
JsonSchemaGeneratorBuilder |
beanFiltersReplace(Class<?>... values)
Configuration property: Bean filters.
|
JsonSchemaGeneratorBuilder |
beanFiltersReplace(Object... values)
Configuration property: Bean filters.
|
JsonSchemaGeneratorBuilder |
beanMapPutReturnsOldValue()
Configuration property: BeanMap.put() returns old property value.
|
JsonSchemaGeneratorBuilder |
beanMapPutReturnsOldValue(boolean value)
Configuration property: BeanMap.put() returns old property value.
|
JsonSchemaGeneratorBuilder |
beanMethodVisibility(Visibility value)
Configuration property: Minimum bean method visibility.
|
JsonSchemaGeneratorBuilder |
beansRequireDefaultConstructor()
Configuration property: Beans require no-arg constructors.
|
JsonSchemaGeneratorBuilder |
beansRequireDefaultConstructor(boolean value)
Configuration property: Beans require no-arg constructors.
|
JsonSchemaGeneratorBuilder |
beansRequireSerializable()
Configuration property: Beans require Serializable interface.
|
JsonSchemaGeneratorBuilder |
beansRequireSerializable(boolean value)
Configuration property: Beans require Serializable interface.
|
JsonSchemaGeneratorBuilder |
beansRequireSettersForGetters()
Configuration property: Beans require setters for getters.
|
JsonSchemaGeneratorBuilder |
beansRequireSettersForGetters(boolean value)
Configuration property: Beans require setters for getters.
|
JsonSchemaGeneratorBuilder |
beansRequireSomeProperties(boolean value)
Configuration property: Beans require at least one property.
|
JsonSchemaGeneratorBuilder |
beanTypePropertyName(String value)
Configuration property: Bean type property name.
|
JsonSchemaGeneratorBuilder |
bpi(Class<?> beanClass,
String value)
Configuration property: Bean property includes.
|
JsonSchemaGeneratorBuilder |
bpi(Map<String,String> values)
Configuration property: Bean property includes.
|
JsonSchemaGeneratorBuilder |
bpi(String beanClassName,
String value)
Configuration property: Bean property includes.
|
JsonSchemaGeneratorBuilder |
bpro(Class<?> beanClass,
String value)
Configuration property: Read-only bean properties.
|
JsonSchemaGeneratorBuilder |
bpro(Map<String,String> values)
Configuration property: Read-only bean properties.
|
JsonSchemaGeneratorBuilder |
bpro(String beanClassName,
String value)
Configuration property: Read-only bean properties.
|
JsonSchemaGeneratorBuilder |
bpwo(Class<?> beanClass,
String properties)
Configuration property: Write-only bean properties.
|
JsonSchemaGeneratorBuilder |
bpwo(Map<String,String> values)
Configuration property: Write-only bean properties.
|
JsonSchemaGeneratorBuilder |
bpwo(String beanClassName,
String value)
Configuration property: Write-only bean properties.
|
JsonSchemaGeneratorBuilder |
bpx(Class<?> beanClass,
String properties)
Configuration property: Bean property excludes.
|
JsonSchemaGeneratorBuilder |
bpx(Map<String,String> values)
Configuration property: Bean property excludes.
|
JsonSchemaGeneratorBuilder |
bpx(String beanClassName,
String value)
Configuration property: Bean property excludes.
|
JsonSchemaGenerator |
build()
Build the object.
|
JsonSchemaGeneratorBuilder |
debug()
Configuration property: Debug mode.
|
JsonSchemaGeneratorBuilder |
defaultSchema(Class<?> c,
ObjectMap schema)
Configuration property: Default schemas.
|
JsonSchemaGeneratorBuilder |
dictionary(Class<?>... values)
Configuration property: Bean dictionary.
|
JsonSchemaGeneratorBuilder |
dictionary(Object... values)
Configuration property: Bean dictionary.
|
JsonSchemaGeneratorBuilder |
dictionaryRemove(Class<?>... values)
Configuration property: Bean dictionary.
|
JsonSchemaGeneratorBuilder |
dictionaryRemove(Object... values)
Configuration property: Bean dictionary.
|
JsonSchemaGeneratorBuilder |
dictionaryReplace(Class<?>... values)
Configuration property: Bean dictionary.
|
JsonSchemaGeneratorBuilder |
dictionaryReplace(Object... values)
Configuration property: Bean dictionary.
|
<T> JsonSchemaGeneratorBuilder |
example(Class<T> c,
T o)
Configuration property: POJO example.
|
<T> JsonSchemaGeneratorBuilder |
exampleJson(Class<T> c,
String value)
Configuration property: POJO example.
|
JsonSchemaGeneratorBuilder |
ignoreInvocationExceptionsOnGetters()
Configuration property: Ignore invocation errors on getters.
|
JsonSchemaGeneratorBuilder |
ignoreInvocationExceptionsOnGetters(boolean value)
Configuration property: Ignore invocation errors on getters.
|
JsonSchemaGeneratorBuilder |
ignoreInvocationExceptionsOnSetters()
Configuration property: Ignore invocation errors on setters.
|
JsonSchemaGeneratorBuilder |
ignoreInvocationExceptionsOnSetters(boolean value)
Configuration property: Ignore invocation errors on setters.
|
JsonSchemaGeneratorBuilder |
ignorePropertiesWithoutSetters(boolean value)
Configuration property: Ignore properties without setters.
|
JsonSchemaGeneratorBuilder |
ignoreTypes(String value)
Configuration property: Ignore types from schema definitions.
|
JsonSchemaGeneratorBuilder |
ignoreUnknownBeanProperties()
Configuration property: Ignore unknown properties.
|
JsonSchemaGeneratorBuilder |
ignoreUnknownBeanProperties(boolean value)
Configuration property: Ignore unknown properties.
|
JsonSchemaGeneratorBuilder |
ignoreUnknownNullBeanProperties(boolean value)
Configuration property: Ignore unknown properties with null values.
|
JsonSchemaGeneratorBuilder |
implClass(Class<?> interfaceClass,
Class<?> implClass)
Configuration property: Implementation classes.
|
JsonSchemaGeneratorBuilder |
implClasses(Map<String,Class<?>> values)
Configuration property: Implementation classes.
|
JsonSchemaGeneratorBuilder |
locale(Locale value)
Configuration property: Locale.
|
JsonSchemaGeneratorBuilder |
mediaType(MediaType value)
Configuration property: Media type.
|
JsonSchemaGeneratorBuilder |
notBeanClasses(Class<?>... values)
Configuration property: Bean class exclusions.
|
JsonSchemaGeneratorBuilder |
notBeanClasses(Object... values)
Configuration property: Bean class exclusions.
|
JsonSchemaGeneratorBuilder |
notBeanClassesRemove(Class<?>... values)
Configuration property: Bean class exclusions.
|
JsonSchemaGeneratorBuilder |
notBeanClassesRemove(Object... values)
Configuration property: Bean class exclusions.
|
JsonSchemaGeneratorBuilder |
notBeanClassesReplace(Class<?>... values)
Configuration property: Bean class exclusions.
|
JsonSchemaGeneratorBuilder |
notBeanClassesReplace(Object... values)
Configuration property: Bean class exclusions.
|
JsonSchemaGeneratorBuilder |
notBeanPackages(Object... values)
Configuration property: Bean package exclusions.
|
JsonSchemaGeneratorBuilder |
notBeanPackages(String... values)
Configuration property: Bean package exclusions.
|
JsonSchemaGeneratorBuilder |
notBeanPackagesRemove(Object... values)
Configuration property: Bean package exclusions.
|
JsonSchemaGeneratorBuilder |
notBeanPackagesRemove(String... values)
Configuration property: Bean package exclusions.
|
JsonSchemaGeneratorBuilder |
notBeanPackagesReplace(Object... values)
Configuration property: Bean package exclusions.
|
JsonSchemaGeneratorBuilder |
notBeanPackagesReplace(String... values)
Configuration property: Bean package exclusions.
|
JsonSchemaGeneratorBuilder |
pojoSwaps(Class<?>... values)
Configuration property: POJO swaps.
|
JsonSchemaGeneratorBuilder |
pojoSwaps(Object... values)
Configuration property: POJO swaps.
|
JsonSchemaGeneratorBuilder |
pojoSwapsRemove(Class<?>... values)
Configuration property: POJO swaps.
|
JsonSchemaGeneratorBuilder |
pojoSwapsRemove(Object... values)
Configuration property: POJO swaps.
|
JsonSchemaGeneratorBuilder |
pojoSwapsReplace(Class<?>... values)
Configuration property: POJO swaps.
|
JsonSchemaGeneratorBuilder |
pojoSwapsReplace(Object... values)
Configuration property: POJO swaps.
|
JsonSchemaGeneratorBuilder |
removeFrom(String name,
Object value)
Removes a value from a SET, LIST, or MAP property.
|
JsonSchemaGeneratorBuilder |
set(Map<String,Object> properties)
Sets multiple configuration properties on this object.
|
JsonSchemaGeneratorBuilder |
set(String name,
Object value)
Sets a configuration property on this object.
|
JsonSchemaGeneratorBuilder |
sortProperties()
Configuration property: Sort bean properties.
|
JsonSchemaGeneratorBuilder |
sortProperties(boolean value)
Configuration property: Sort bean properties.
|
JsonSchemaGeneratorBuilder |
timeZone(TimeZone value)
Configuration property: TimeZone.
|
JsonSchemaGeneratorBuilder |
useBeanDefs()
Configuration property: Use bean definitions.
|
JsonSchemaGeneratorBuilder |
useBeanDefs(boolean value)
Configuration property: Use bean definitions.
|
JsonSchemaGeneratorBuilder |
useEnumNames()
Configuration property: Use enum names.
|
JsonSchemaGeneratorBuilder |
useEnumNames(boolean value)
Configuration property: Use enum names.
|
JsonSchemaGeneratorBuilder |
useInterfaceProxies(boolean value)
Configuration property: Use interface proxies.
|
JsonSchemaGeneratorBuilder |
useJavaBeanIntrospector()
Configuration property: Use Java Introspector.
|
JsonSchemaGeneratorBuilder |
useJavaBeanIntrospector(boolean value)
Configuration property: Use Java Introspector.
|
detectRecursions, detectRecursions, ignoreRecursions, ignoreRecursions, initialDepth, maxDepth
debug, examples, excludeProperties, excludeProperties, excludeProperties, fluentSetters, fluentSetters, includeProperties, includeProperties, includeProperties, propertyNamer
build, getPropertyStore, getPropertyStoreBuilder, peek, peek
public JsonSchemaGeneratorBuilder()
public JsonSchemaGeneratorBuilder(PropertyStore ps)
ps
- The initial configuration settings for this builder.public JsonSchemaGenerator build()
ContextBuilder
build
in class BeanTraverseBuilder
public JsonSchemaGeneratorBuilder addDescriptionsTo(String value)
Identifies which categories of types that descriptions should be automatically added to generated schemas.
The description is the result of calling ClassMeta.getFullName()
.
value
- The new value for this property.
public JsonSchemaGeneratorBuilder addExamplesTo(String value)
Identifies which categories of types that examples should be automatically added to generated schemas.
The examples come from calling ClassMeta.getExample(BeanSession)
which in turn gets examples
from the following:
value
- The new value for this property.
public JsonSchemaGeneratorBuilder allowNestedDescriptions(boolean value)
Identifies whether nested descriptions are allowed in schema definitions.
value
- The new value for this property.public JsonSchemaGeneratorBuilder allowNestedDescriptions()
Identifies whether nested descriptions are allowed in schema definitions.
public JsonSchemaGeneratorBuilder allowNestedExamples(boolean value)
Identifies whether nested examples are allowed in schema definitions.
value
- The new value for this property.public JsonSchemaGeneratorBuilder allowNestedExamples()
Identifies whether nested examples are allowed in schema definitions.
public JsonSchemaGeneratorBuilder beanDefMapper(Class<? extends BeanDefMapper> value)
Interface to use for converting Bean classes to definition IDs and URIs.
Used primarily for defining common definition sections for beans in Swagger JSON.
This setting is ignored if JsonSchemaGenerator.JSONSCHEMA_useBeanDefs
is not enabled.
value
- The new value for this property.
public JsonSchemaGeneratorBuilder beanDefMapper(BeanDefMapper value)
Interface to use for converting Bean classes to definition IDs and URIs.
Used primarily for defining common definition sections for beans in Swagger JSON.
This setting is ignored if JsonSchemaGenerator.JSONSCHEMA_useBeanDefs
is not enabled.
value
- The new value for this property.public JsonSchemaGeneratorBuilder defaultSchema(Class<?> c, ObjectMap schema)
Allows you to override or provide custom schema information for particular class types.
Keys are full class names.
c
- The class to define a default schema for.schema
- The schema.public JsonSchemaGeneratorBuilder ignoreTypes(String value)
Defines class name patterns that should be ignored when generating schema definitions in the generated Swagger documentation.
value
- A comma-delimited list of types to ignore.public JsonSchemaGeneratorBuilder useBeanDefs(boolean value)
When enabled, schemas on beans will be serialized as the following:
{
type:
The definitions can then be retrieved from the session using JsonSchemaGeneratorSession.getBeanDefs()
.
Definitions can also be added programmatically using JsonSchemaGeneratorSession.addBeanDef(String, ObjectMap)
.
value
- The new value for this property.
public JsonSchemaGeneratorBuilder useBeanDefs()
When enabled, schemas on beans will be serialized as the following:
{
type:
The definitions can then be retrieved from the session using JsonSchemaGeneratorSession.getBeanDefs()
.
Definitions can also be added programmatically using JsonSchemaGeneratorSession.addBeanDef(String, ObjectMap)
.
public JsonSchemaGeneratorBuilder 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 BeanTraverseBuilder
values
- The values to add to this property.public JsonSchemaGeneratorBuilder 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 BeanTraverseBuilder
value
- The new value for this property.
Visibility.PUBLIC
.public JsonSchemaGeneratorBuilder beanConstructorVisibility(Visibility value)
BeanContextBuilder
Only look for constructors with the specified minimum visibility.
beanConstructorVisibility
in class BeanTraverseBuilder
value
- The new value for this property.
Visibility.PUBLIC
.@Deprecated public JsonSchemaGeneratorBuilder beanDictionary(Class<?>... values)
BeanContextBuilder
BeanContextBuilder.dictionary(Class...)
Same as BeanContextBuilder.beanDictionary(Object...)
but takes in an array of classes.
beanDictionary
in class BeanTraverseBuilder
values
- The values to add to this property.@Deprecated public JsonSchemaGeneratorBuilder 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 BeanTraverseBuilder
values
- The values to add to this property.@Deprecated public JsonSchemaGeneratorBuilder beanDictionaryReplace(Class<?>... values)
BeanContextBuilder
BeanContextBuilder.dictionaryReplace(Class...)
Same as BeanContextBuilder.beanDictionary(Object...)
but replaces the existing value.
beanDictionaryReplace
in class BeanTraverseBuilder
values
- The new values for this property.@Deprecated public JsonSchemaGeneratorBuilder beanDictionaryReplace(Object... values)
BeanContextBuilder
BeanContextBuilder.dictionaryReplace(Object...)
Same as BeanContextBuilder.beanDictionary(Object...)
but replaces the existing value.
beanDictionaryReplace
in class BeanTraverseBuilder
values
- The new values for this property.@Deprecated public JsonSchemaGeneratorBuilder 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 BeanTraverseBuilder
values
- The values to remove from this property.@Deprecated public JsonSchemaGeneratorBuilder 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 BeanTraverseBuilder
values
- The values to remove from this property.public JsonSchemaGeneratorBuilder beanFieldVisibility(Visibility value)
BeanContextBuilder
Only look for bean fields with the specified minimum visibility.
beanFieldVisibility
in class BeanTraverseBuilder
value
- The new value for this property.
Visibility.PUBLIC
.public JsonSchemaGeneratorBuilder beanFilters(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...)
but takes in an array of classes.
beanFilters
in class BeanTraverseBuilder
values
- The values to add to this property.public JsonSchemaGeneratorBuilder 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 BeanTraverseBuilder
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 JsonSchemaGeneratorBuilder beanFiltersReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...)
but replaces the existing values.
beanFiltersReplace
in class BeanTraverseBuilder
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 JsonSchemaGeneratorBuilder beanFiltersReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...)
but replaces the existing values.
beanFiltersReplace
in class BeanTraverseBuilder
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 JsonSchemaGeneratorBuilder beanFiltersRemove(Class<?>... values)
BeanContextBuilder
Removes from the list of classes that make up the bean filters in this bean context.
beanFiltersRemove
in class BeanTraverseBuilder
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 JsonSchemaGeneratorBuilder beanFiltersRemove(Object... values)
BeanContextBuilder
Removes from the list of classes that make up the bean filters in this bean context.
beanFiltersRemove
in class BeanTraverseBuilder
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 JsonSchemaGeneratorBuilder beanMapPutReturnsOldValue(boolean value)
BeanContextBuilder
If BeanMap.put()
method will return old property
values.
Otherwise, it returns
beanMapPutReturnsOldValue
in class BeanTraverseBuilder
value
- The new value for this property.
public JsonSchemaGeneratorBuilder beanMapPutReturnsOldValue()
BeanContextBuilder
Shortcut for calling beanMapPutReturnsOldValue(
.
beanMapPutReturnsOldValue
in class BeanTraverseBuilder
public JsonSchemaGeneratorBuilder beanMethodVisibility(Visibility value)
BeanContextBuilder
Only look for bean methods with the specified minimum visibility.
beanMethodVisibility
in class BeanTraverseBuilder
value
- The new value for this property.
Visibility.PUBLIC
public JsonSchemaGeneratorBuilder beansRequireDefaultConstructor(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString()
method.
beansRequireDefaultConstructor
in class BeanTraverseBuilder
value
- The new value for this property.
public JsonSchemaGeneratorBuilder beansRequireDefaultConstructor()
BeanContextBuilder
Shortcut for calling beansRequireDefaultConstructor(
.
beansRequireDefaultConstructor
in class BeanTraverseBuilder
public JsonSchemaGeneratorBuilder 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 BeanTraverseBuilder
value
- The new value for this property.
public JsonSchemaGeneratorBuilder beansRequireSerializable()
BeanContextBuilder
Shortcut for calling beansRequireSerializable(
.
beansRequireSerializable
in class BeanTraverseBuilder
public JsonSchemaGeneratorBuilder beansRequireSettersForGetters(boolean value)
BeanContextBuilder
If
Otherwise, they will be ignored.
beansRequireSettersForGetters
in class BeanTraverseBuilder
value
- The new value for this property.
public JsonSchemaGeneratorBuilder beansRequireSettersForGetters()
BeanContextBuilder
Shortcut for calling beansRequireSettersForGetters(
.
beansRequireSettersForGetters
in class BeanTraverseBuilder
public JsonSchemaGeneratorBuilder beansRequireSomeProperties(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString()
method.
beansRequireSomeProperties
in class BeanTraverseBuilder
value
- The new value for this property.
public JsonSchemaGeneratorBuilder 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 BeanTraverseBuilder
value
- The new value for this property.
public JsonSchemaGeneratorBuilder bpi(Class<?> beanClass, String value)
BeanContextBuilder
Specifies the set and order of names of properties associated with the bean class.
bpi
in class BeanTraverseBuilder
beanClass
- The bean class.value
- Comma-delimited list of property names.public JsonSchemaGeneratorBuilder bpi(Map<String,String> values)
BeanContextBuilder
Specifies the set and order of names of properties associated with the bean class.
bpi
in class BeanTraverseBuilder
values
- The new value for this property.public JsonSchemaGeneratorBuilder bpi(String beanClassName, String value)
BeanContextBuilder
Specifies the set and order of names of properties associated with the bean class.
bpi
in class BeanTraverseBuilder
beanClassName
- The bean class name.
value
- Comma-delimited list of property names.public JsonSchemaGeneratorBuilder bpx(Class<?> beanClass, String properties)
BeanContextBuilder
Specifies to exclude the specified list of properties for the specified bean class.
bpx
in class BeanTraverseBuilder
beanClass
- The bean class.properties
- Comma-delimited list of property names.public JsonSchemaGeneratorBuilder bpx(Map<String,String> values)
BeanContextBuilder
Specifies to exclude the specified list of properties for the specified bean classes.
bpx
in class BeanTraverseBuilder
values
- The new value for this property.public JsonSchemaGeneratorBuilder bpx(String beanClassName, String value)
BeanContextBuilder
bpx
in class BeanTraverseBuilder
beanClassName
- The bean class name.
value
- Comma-delimited list of property names.public JsonSchemaGeneratorBuilder bpro(Class<?> beanClass, String value)
BeanContextBuilder
Specifies the read-only properties for the specified bean class.
bpro
in class BeanTraverseBuilder
beanClass
- The bean class.value
- Comma-delimited list of property names.public JsonSchemaGeneratorBuilder bpro(Map<String,String> values)
BeanContextBuilder
Specifies the read-only properties for the specified bean classes.
bpro
in class BeanTraverseBuilder
values
- The new value for this property.public JsonSchemaGeneratorBuilder bpro(String beanClassName, String value)
BeanContextBuilder
Specifies the read-only properties for the specified bean class.
bpro
in class BeanTraverseBuilder
beanClassName
- The bean class name.
value
- Comma-delimited list of property names.public JsonSchemaGeneratorBuilder bpwo(Class<?> beanClass, String properties)
BeanContextBuilder
Specifies the write-only properties for the specified bean class.
bpwo
in class BeanTraverseBuilder
beanClass
- The bean class.properties
- Comma-delimited list of property names.public JsonSchemaGeneratorBuilder bpwo(Map<String,String> values)
BeanContextBuilder
Specifies the write-only properties for the specified bean classes.
bpwo
in class BeanTraverseBuilder
values
- The new value for this property.public JsonSchemaGeneratorBuilder bpwo(String beanClassName, String value)
BeanContextBuilder
Specifies the write-only properties for the specified bean class.
bpwo
in class BeanTraverseBuilder
beanClassName
- The bean class name.
value
- Comma-delimited list of property names.public JsonSchemaGeneratorBuilder debug()
BeanContextBuilder
Shortcut for calling debug(
.
debug
in class BeanTraverseBuilder
public JsonSchemaGeneratorBuilder dictionary(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...)
but takes in an array of classes.
dictionary
in class BeanTraverseBuilder
values
- The values to add to this property.public JsonSchemaGeneratorBuilder dictionary(Object... values)
BeanContextBuilder
Adds to the list of classes that make up the bean dictionary in this bean context.
dictionary
in class BeanTraverseBuilder
values
- The values to add to this property.public JsonSchemaGeneratorBuilder dictionaryReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...)
but replaces the existing value.
dictionaryReplace
in class BeanTraverseBuilder
values
- The new values for this property.public JsonSchemaGeneratorBuilder dictionaryReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...)
but replaces the existing value.
dictionaryReplace
in class BeanTraverseBuilder
values
- The new values for this property.public JsonSchemaGeneratorBuilder dictionaryRemove(Class<?>... values)
BeanContextBuilder
Removes from the list of classes that make up the bean dictionary in this bean context.
dictionaryRemove
in class BeanTraverseBuilder
values
- The values to remove from this property.public JsonSchemaGeneratorBuilder dictionaryRemove(Object... values)
BeanContextBuilder
Removes from the list of classes that make up the bean dictionary in this bean context.
dictionaryRemove
in class BeanTraverseBuilder
values
- The values to remove from this property.public <T> JsonSchemaGeneratorBuilder example(Class<T> c, T o)
BeanContextBuilder
Specifies an example of the specified class.
example
in class BeanTraverseBuilder
c
- The POJO class.o
- An instance of the POJO class used for examples.public <T> JsonSchemaGeneratorBuilder exampleJson(Class<T> c, String value)
BeanContextBuilder
Specifies an example of the specified class.
exampleJson
in class BeanTraverseBuilder
T
- The POJO class type.c
- The POJO class.value
- The simple JSON representation of the example.public JsonSchemaGeneratorBuilder ignoreInvocationExceptionsOnGetters(boolean value)
BeanContextBuilder
If BeanRuntimeException
is thrown.
ignoreInvocationExceptionsOnGetters
in class BeanTraverseBuilder
value
- The new value for this property.
public JsonSchemaGeneratorBuilder ignoreInvocationExceptionsOnGetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnGetters(
.
ignoreInvocationExceptionsOnGetters
in class BeanTraverseBuilder
public JsonSchemaGeneratorBuilder ignoreInvocationExceptionsOnSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreInvocationExceptionsOnSetters
in class BeanTraverseBuilder
value
- The new value for this property.
public JsonSchemaGeneratorBuilder ignoreInvocationExceptionsOnSetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnSetters(
.
ignoreInvocationExceptionsOnSetters
in class BeanTraverseBuilder
public JsonSchemaGeneratorBuilder ignorePropertiesWithoutSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignorePropertiesWithoutSetters
in class BeanTraverseBuilder
value
- The new value for this property.
public JsonSchemaGeneratorBuilder ignoreUnknownBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreUnknownBeanProperties
in class BeanTraverseBuilder
value
- The new value for this property.
public JsonSchemaGeneratorBuilder ignoreUnknownBeanProperties()
BeanContextBuilder
Shortcut for calling ignoreUnknownBeanProperties(
.
ignoreUnknownBeanProperties
in class BeanTraverseBuilder
public JsonSchemaGeneratorBuilder ignoreUnknownNullBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreUnknownNullBeanProperties
in class BeanTraverseBuilder
value
- The new value for this property.
public JsonSchemaGeneratorBuilder implClass(Class<?> interfaceClass, Class<?> implClass)
BeanContextBuilder
implClass
in class BeanTraverseBuilder
interfaceClass
- The interface class.implClass
- The implementation class.public JsonSchemaGeneratorBuilder 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 BeanTraverseBuilder
values
- The new value for this property.public JsonSchemaGeneratorBuilder locale(Locale value)
BeanContextBuilder
Specifies a default locale for serializer and parser sessions.
locale
in class BeanTraverseBuilder
value
- The new value for this property.public JsonSchemaGeneratorBuilder mediaType(MediaType value)
BeanContextBuilder
Specifies a default media type value for serializer and parser sessions.
mediaType
in class BeanTraverseBuilder
value
- The new value for this property.public JsonSchemaGeneratorBuilder 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 BeanTraverseBuilder
values
- The values to add to this property.public JsonSchemaGeneratorBuilder 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 BeanTraverseBuilder
values
- The values to add to this property.
public JsonSchemaGeneratorBuilder notBeanClassesReplace(Class<?>... values)
BeanContextBuilder
Not-bean classes are converted to
notBeanClassesReplace
in class BeanTraverseBuilder
values
- The new value for this property.public JsonSchemaGeneratorBuilder notBeanClassesReplace(Object... values)
BeanContextBuilder
Not-bean classes are converted to
notBeanClassesReplace
in class BeanTraverseBuilder
values
- The new value for this property.
public JsonSchemaGeneratorBuilder notBeanClassesRemove(Class<?>... values)
BeanContextBuilder
notBeanClassesRemove
in class BeanTraverseBuilder
values
- The values to remove from this property.public JsonSchemaGeneratorBuilder notBeanClassesRemove(Object... values)
BeanContextBuilder
notBeanClassesRemove
in class BeanTraverseBuilder
values
- The values to remove from this property.
public JsonSchemaGeneratorBuilder notBeanPackages(Object... values)
BeanContextBuilder
notBeanPackages
in class BeanTraverseBuilder
values
- The values to add to this property.
public JsonSchemaGeneratorBuilder notBeanPackages(String... values)
BeanContextBuilder
notBeanPackages
in class BeanTraverseBuilder
values
- The values to add to this property.public JsonSchemaGeneratorBuilder notBeanPackagesReplace(String... values)
BeanContextBuilder
notBeanPackagesReplace
in class BeanTraverseBuilder
values
- public JsonSchemaGeneratorBuilder notBeanPackagesReplace(Object... values)
BeanContextBuilder
notBeanPackagesReplace
in class BeanTraverseBuilder
values
- public JsonSchemaGeneratorBuilder notBeanPackagesRemove(String... values)
BeanContextBuilder
notBeanPackagesRemove
in class BeanTraverseBuilder
values
- The values to remove from this property.public JsonSchemaGeneratorBuilder notBeanPackagesRemove(Object... values)
BeanContextBuilder
notBeanPackagesRemove
in class BeanTraverseBuilder
values
- public JsonSchemaGeneratorBuilder pojoSwaps(Class<?>... values)
BeanContextBuilder
pojoSwaps
in class BeanTraverseBuilder
values
- The values to add to this property.public JsonSchemaGeneratorBuilder pojoSwaps(Object... values)
BeanContextBuilder
pojoSwaps
in class BeanTraverseBuilder
values
- The values to add to this property.
PojoSwap
.
SurrogateSwap
.
public JsonSchemaGeneratorBuilder pojoSwapsReplace(Class<?>... values)
BeanContextBuilder
pojoSwapsReplace
in class BeanTraverseBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public JsonSchemaGeneratorBuilder pojoSwapsReplace(Object... values)
BeanContextBuilder
pojoSwapsReplace
in class BeanTraverseBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public JsonSchemaGeneratorBuilder pojoSwapsRemove(Class<?>... values)
BeanContextBuilder
pojoSwapsRemove
in class BeanTraverseBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public JsonSchemaGeneratorBuilder pojoSwapsRemove(Object... values)
BeanContextBuilder
pojoSwapsRemove
in class BeanTraverseBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public JsonSchemaGeneratorBuilder sortProperties(boolean value)
BeanContextBuilder
When
sortProperties
in class BeanTraverseBuilder
value
- The new value for this property.
public JsonSchemaGeneratorBuilder sortProperties()
BeanContextBuilder
Shortcut for calling sortProperties(
.
sortProperties
in class BeanTraverseBuilder
public JsonSchemaGeneratorBuilder timeZone(TimeZone value)
BeanContextBuilder
timeZone
in class BeanTraverseBuilder
value
- The new value for this property.public JsonSchemaGeneratorBuilder useEnumNames(boolean value)
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString()
.
useEnumNames
in class BeanTraverseBuilder
value
- The property value.public JsonSchemaGeneratorBuilder useEnumNames()
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString()
.
useEnumNames
in class BeanTraverseBuilder
public JsonSchemaGeneratorBuilder useInterfaceProxies(boolean value)
BeanContextBuilder
If InvocationHandler
if there is no other way of instantiating them.
useInterfaceProxies
in class BeanTraverseBuilder
value
- The new value for this property.
public JsonSchemaGeneratorBuilder 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 BeanTraverseBuilder
value
- The new value for this property.
public JsonSchemaGeneratorBuilder useJavaBeanIntrospector()
BeanContextBuilder
Shortcut for calling useJavaBeanIntrospector(
.
useJavaBeanIntrospector
in class BeanTraverseBuilder
public JsonSchemaGeneratorBuilder set(String name, Object value)
ContextBuilder
set
in class BeanTraverseBuilder
name
- The property name.value
- The property value.PropertyStoreBuilder.set(String, Object)
public JsonSchemaGeneratorBuilder set(Map<String,Object> properties)
ContextBuilder
set
in class BeanTraverseBuilder
properties
- The properties to set on this class.PropertyStoreBuilder.set(java.util.Map)
public JsonSchemaGeneratorBuilder add(Map<String,Object> properties)
ContextBuilder
add
in class BeanTraverseBuilder
properties
- The properties to set on this class.PropertyStoreBuilder.add(java.util.Map)
public JsonSchemaGeneratorBuilder addTo(String name, Object value)
ContextBuilder
addTo
in class BeanTraverseBuilder
name
- The property name.value
- The new value to add to the SET property.public JsonSchemaGeneratorBuilder addTo(String name, String key, Object value)
ContextBuilder
addTo
in class BeanTraverseBuilder
name
- The property name.key
- The property value map key.value
- The property value map value.public JsonSchemaGeneratorBuilder removeFrom(String name, Object value)
ContextBuilder
removeFrom
in class BeanTraverseBuilder
name
- The property name.value
- The property value in the SET property.public JsonSchemaGeneratorBuilder apply(PropertyStore copyFrom)
ContextBuilder
apply
in class BeanTraverseBuilder
copyFrom
- The factory whose settings are being copied.public JsonSchemaGeneratorBuilder applyAnnotations(AnnotationList al, VarResolverSession vrs)
ContextBuilder
applyAnnotations
in class BeanTraverseBuilder
al
- The list of all annotations annotated with PropertyStoreApply
.vrs
- The string resolver for resolving variables in annotation values.public JsonSchemaGeneratorBuilder 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 BeanTraverseBuilder
fromClasses
- The classes on which the annotations are defined.public JsonSchemaGeneratorBuilder 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 BeanTraverseBuilder
fromMethods
- The methods on which the annotations are defined.Copyright © 2016–2020 The Apache Software Foundation. All rights reserved.