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 |
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<?> fromClass)
Applies any of the various
|
JsonSchemaGeneratorBuilder |
applyAnnotations(Method fromMethod)
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, maxDepthdebug, examples, excludeProperties, excludeProperties, excludeProperties, fluentSetters, fluentSetters, includeProperties, includeProperties, includeProperties, propertyNamerbuild, getPropertyStore, getPropertyStoreBuilder, peek, peekpublic JsonSchemaGeneratorBuilder()
public JsonSchemaGeneratorBuilder(PropertyStore ps)
ps - The initial configuration settings for this builder.public JsonSchemaGenerator build()
ContextBuilderbuild in class BeanTraverseBuilderpublic 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 beanClassVisibility(Visibility value)
BeanContextBuilderClasses are not considered beans unless they meet the minimum visibility requirements.
For example, if the visibility is
beanClassVisibility in class BeanTraverseBuildervalue - The new value for this property.
Visibility.PUBLIC.public JsonSchemaGeneratorBuilder beanConstructorVisibility(Visibility value)
BeanContextBuilderOnly look for constructors with the specified minimum visibility.
beanConstructorVisibility in class BeanTraverseBuildervalue - The new value for this property.
Visibility.PUBLIC.@Deprecated public JsonSchemaGeneratorBuilder beanDictionary(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but takes in an array of classes.
beanDictionary in class BeanTraverseBuildervalues - The values to add to this property.@Deprecated public JsonSchemaGeneratorBuilder beanDictionary(Object... values)
BeanContextBuilderAdds to the list of classes that make up the bean dictionary in this bean context.
beanDictionary in class BeanTraverseBuildervalues - The values to add to this property.@Deprecated public JsonSchemaGeneratorBuilder beanDictionaryReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but replaces the existing value.
beanDictionaryReplace in class BeanTraverseBuildervalues - The new values for this property.@Deprecated public JsonSchemaGeneratorBuilder beanDictionaryReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but replaces the existing value.
beanDictionaryReplace in class BeanTraverseBuildervalues - The new values for this property.@Deprecated public JsonSchemaGeneratorBuilder beanDictionaryRemove(Class<?>... values)
BeanContextBuilderRemoves from the list of classes that make up the bean dictionary in this bean context.
beanDictionaryRemove in class BeanTraverseBuildervalues - The values to remove from this property.@Deprecated public JsonSchemaGeneratorBuilder beanDictionaryRemove(Object... values)
BeanContextBuilderRemoves from the list of classes that make up the bean dictionary in this bean context.
beanDictionaryRemove in class BeanTraverseBuildervalues - The values to remove from this property.public JsonSchemaGeneratorBuilder beanFieldVisibility(Visibility value)
BeanContextBuilderOnly look for bean fields with the specified minimum visibility.
beanFieldVisibility in class BeanTraverseBuildervalue - 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 BeanTraverseBuildervalues - 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 BeanTraverseBuildervalues - 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 BeanTraverseBuildervalues - 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 BeanTraverseBuildervalues - 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)
BeanContextBuilderRemoves from the list of classes that make up the bean filters in this bean context.
beanFiltersRemove in class BeanTraverseBuildervalues - 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)
BeanContextBuilderRemoves from the list of classes that make up the bean filters in this bean context.
beanFiltersRemove in class BeanTraverseBuildervalues - 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 BeanTraverseBuildervalue - The new value for this property.
public JsonSchemaGeneratorBuilder beanMapPutReturnsOldValue()
BeanContextBuilder
Shortcut for calling beanMapPutReturnsOldValue(.
beanMapPutReturnsOldValue in class BeanTraverseBuilderpublic JsonSchemaGeneratorBuilder beanMethodVisibility(Visibility value)
BeanContextBuilderOnly look for bean methods with the specified minimum visibility.
beanMethodVisibility in class BeanTraverseBuildervalue - The new value for this property.
Visibility.PUBLICpublic JsonSchemaGeneratorBuilder beansRequireDefaultConstructor(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString() method.
beansRequireDefaultConstructor in class BeanTraverseBuildervalue - The new value for this property.
public JsonSchemaGeneratorBuilder beansRequireDefaultConstructor()
BeanContextBuilder
Shortcut for calling beansRequireDefaultConstructor(.
beansRequireDefaultConstructor in class BeanTraverseBuilderpublic 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 BeanTraverseBuildervalue - The new value for this property.
public JsonSchemaGeneratorBuilder beansRequireSerializable()
BeanContextBuilder
Shortcut for calling beansRequireSerializable(.
beansRequireSerializable in class BeanTraverseBuilderpublic JsonSchemaGeneratorBuilder beansRequireSettersForGetters(boolean value)
BeanContextBuilder
If
Otherwise, they will be ignored.
beansRequireSettersForGetters in class BeanTraverseBuildervalue - The new value for this property.
public JsonSchemaGeneratorBuilder beansRequireSettersForGetters()
BeanContextBuilder
Shortcut for calling beansRequireSettersForGetters(.
beansRequireSettersForGetters in class BeanTraverseBuilderpublic JsonSchemaGeneratorBuilder beansRequireSomeProperties(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString() method.
beansRequireSomeProperties in class BeanTraverseBuildervalue - The new value for this property.
public JsonSchemaGeneratorBuilder beanTypePropertyName(String value)
BeanContextBuilderThis 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 BeanTraverseBuildervalue - The new value for this property.
public JsonSchemaGeneratorBuilder bpi(Class<?> beanClass, String value)
BeanContextBuilderSpecifies the set and order of names of properties associated with the bean class.
bpi in class BeanTraverseBuilderbeanClass - The bean class.value - Comma-delimited list of property names.public JsonSchemaGeneratorBuilder bpi(Map<String,String> values)
BeanContextBuilderSpecifies the set and order of names of properties associated with the bean class.
bpi in class BeanTraverseBuildervalues - The new value for this property.public JsonSchemaGeneratorBuilder bpi(String beanClassName, String value)
BeanContextBuilderSpecifies the set and order of names of properties associated with the bean class.
bpi in class BeanTraverseBuilderbeanClassName - The bean class name.
value - Comma-delimited list of property names.public JsonSchemaGeneratorBuilder bpx(Class<?> beanClass, String properties)
BeanContextBuilderSpecifies to exclude the specified list of properties for the specified bean class.
bpx in class BeanTraverseBuilderbeanClass - The bean class.properties - Comma-delimited list of property names.public JsonSchemaGeneratorBuilder bpx(Map<String,String> values)
BeanContextBuilderSpecifies to exclude the specified list of properties for the specified bean classes.
bpx in class BeanTraverseBuildervalues - The new value for this property.public JsonSchemaGeneratorBuilder bpx(String beanClassName, String value)
BeanContextBuilderbpx in class BeanTraverseBuilderbeanClassName - The bean class name.
value - Comma-delimited list of property names.public JsonSchemaGeneratorBuilder bpro(Class<?> beanClass, String value)
BeanContextBuilderSpecifies the read-only properties for the specified bean class.
bpro in class BeanTraverseBuilderbeanClass - The bean class.value - Comma-delimited list of property names.public JsonSchemaGeneratorBuilder bpro(Map<String,String> values)
BeanContextBuilderSpecifies the read-only properties for the specified bean classes.
bpro in class BeanTraverseBuildervalues - The new value for this property.public JsonSchemaGeneratorBuilder bpro(String beanClassName, String value)
BeanContextBuilderSpecifies the read-only properties for the specified bean class.
bpro in class BeanTraverseBuilderbeanClassName - The bean class name.
value - Comma-delimited list of property names.public JsonSchemaGeneratorBuilder bpwo(Class<?> beanClass, String properties)
BeanContextBuilderSpecifies the write-only properties for the specified bean class.
bpwo in class BeanTraverseBuilderbeanClass - The bean class.properties - Comma-delimited list of property names.public JsonSchemaGeneratorBuilder bpwo(Map<String,String> values)
BeanContextBuilderSpecifies the write-only properties for the specified bean classes.
bpwo in class BeanTraverseBuildervalues - The new value for this property.public JsonSchemaGeneratorBuilder bpwo(String beanClassName, String value)
BeanContextBuilderSpecifies the write-only properties for the specified bean class.
bpwo in class BeanTraverseBuilderbeanClassName - The bean class name.
value - Comma-delimited list of property names.public JsonSchemaGeneratorBuilder debug()
BeanContextBuilder
Shortcut for calling debug(.
debug in class BeanTraverseBuilderpublic JsonSchemaGeneratorBuilder dictionary(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but takes in an array of classes.
dictionary in class BeanTraverseBuildervalues - The values to add to this property.public JsonSchemaGeneratorBuilder dictionary(Object... values)
BeanContextBuilderAdds to the list of classes that make up the bean dictionary in this bean context.
dictionary in class BeanTraverseBuildervalues - 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 BeanTraverseBuildervalues - 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 BeanTraverseBuildervalues - The new values for this property.public JsonSchemaGeneratorBuilder dictionaryRemove(Class<?>... values)
BeanContextBuilderRemoves from the list of classes that make up the bean dictionary in this bean context.
dictionaryRemove in class BeanTraverseBuildervalues - The values to remove from this property.public JsonSchemaGeneratorBuilder dictionaryRemove(Object... values)
BeanContextBuilderRemoves from the list of classes that make up the bean dictionary in this bean context.
dictionaryRemove in class BeanTraverseBuildervalues - The values to remove from this property.public <T> JsonSchemaGeneratorBuilder example(Class<T> c, T o)
BeanContextBuilderSpecifies an example of the specified class.
example in class BeanTraverseBuilderc - The POJO class.o - An instance of the POJO class used for examples.public <T> JsonSchemaGeneratorBuilder exampleJson(Class<T> c, String value)
BeanContextBuilderSpecifies an example of the specified class.
exampleJson in class BeanTraverseBuilderT - 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 BeanTraverseBuildervalue - The new value for this property.
public JsonSchemaGeneratorBuilder ignoreInvocationExceptionsOnGetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnGetters(.
ignoreInvocationExceptionsOnGetters in class BeanTraverseBuilderpublic JsonSchemaGeneratorBuilder ignoreInvocationExceptionsOnSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException is thrown.
ignoreInvocationExceptionsOnSetters in class BeanTraverseBuildervalue - The new value for this property.
public JsonSchemaGeneratorBuilder ignoreInvocationExceptionsOnSetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnSetters(.
ignoreInvocationExceptionsOnSetters in class BeanTraverseBuilderpublic JsonSchemaGeneratorBuilder ignorePropertiesWithoutSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException is thrown.
ignorePropertiesWithoutSetters in class BeanTraverseBuildervalue - The new value for this property.
public JsonSchemaGeneratorBuilder ignoreUnknownBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException is thrown.
ignoreUnknownBeanProperties in class BeanTraverseBuildervalue - The new value for this property.
public JsonSchemaGeneratorBuilder ignoreUnknownBeanProperties()
BeanContextBuilder
Shortcut for calling ignoreUnknownBeanProperties(.
ignoreUnknownBeanProperties in class BeanTraverseBuilderpublic JsonSchemaGeneratorBuilder ignoreUnknownNullBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException is thrown.
ignoreUnknownNullBeanProperties in class BeanTraverseBuildervalue - The new value for this property.
public JsonSchemaGeneratorBuilder implClass(Class<?> interfaceClass, Class<?> implClass)
BeanContextBuilderimplClass in class BeanTraverseBuilderinterfaceClass - The interface class.implClass - The implementation class.public JsonSchemaGeneratorBuilder implClasses(Map<String,Class<?>> values)
BeanContextBuilderFor 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 BeanTraverseBuildervalues - The new value for this property.public JsonSchemaGeneratorBuilder locale(Locale value)
BeanContextBuilderSpecifies a default locale for serializer and parser sessions.
locale in class BeanTraverseBuildervalue - The new value for this property.public JsonSchemaGeneratorBuilder mediaType(MediaType value)
BeanContextBuilderSpecifies a default media type value for serializer and parser sessions.
mediaType in class BeanTraverseBuildervalue - 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 BeanTraverseBuildervalues - 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 BeanTraverseBuildervalues - The values to add to this property.
public JsonSchemaGeneratorBuilder notBeanClassesReplace(Class<?>... values)
BeanContextBuilder
Not-bean classes are converted to
notBeanClassesReplace in class BeanTraverseBuildervalues - The new value for this property.public JsonSchemaGeneratorBuilder notBeanClassesReplace(Object... values)
BeanContextBuilder
Not-bean classes are converted to
notBeanClassesReplace in class BeanTraverseBuildervalues - The new value for this property.
public JsonSchemaGeneratorBuilder notBeanClassesRemove(Class<?>... values)
BeanContextBuildernotBeanClassesRemove in class BeanTraverseBuildervalues - The values to remove from this property.public JsonSchemaGeneratorBuilder notBeanClassesRemove(Object... values)
BeanContextBuildernotBeanClassesRemove in class BeanTraverseBuildervalues - The values to remove from this property.
public JsonSchemaGeneratorBuilder notBeanPackages(Object... values)
BeanContextBuildernotBeanPackages in class BeanTraverseBuildervalues - The values to add to this property.
public JsonSchemaGeneratorBuilder notBeanPackages(String... values)
BeanContextBuildernotBeanPackages in class BeanTraverseBuildervalues - The values to add to this property.public JsonSchemaGeneratorBuilder notBeanPackagesReplace(String... values)
BeanContextBuildernotBeanPackagesReplace in class BeanTraverseBuildervalues - public JsonSchemaGeneratorBuilder notBeanPackagesReplace(Object... values)
BeanContextBuildernotBeanPackagesReplace in class BeanTraverseBuildervalues - public JsonSchemaGeneratorBuilder notBeanPackagesRemove(String... values)
BeanContextBuildernotBeanPackagesRemove in class BeanTraverseBuildervalues - The values to remove from this property.public JsonSchemaGeneratorBuilder notBeanPackagesRemove(Object... values)
BeanContextBuildernotBeanPackagesRemove in class BeanTraverseBuildervalues - public JsonSchemaGeneratorBuilder pojoSwaps(Class<?>... values)
BeanContextBuilderpojoSwaps in class BeanTraverseBuildervalues - The values to add to this property.public JsonSchemaGeneratorBuilder pojoSwaps(Object... values)
BeanContextBuilderpojoSwaps in class BeanTraverseBuildervalues - The values to add to this property.
PojoSwap.
SurrogateSwap.
public JsonSchemaGeneratorBuilder pojoSwapsReplace(Class<?>... values)
BeanContextBuilderpojoSwapsReplace in class BeanTraverseBuildervalues - The values to remove from this property.
PojoSwap.
SurrogateSwap.
public JsonSchemaGeneratorBuilder pojoSwapsReplace(Object... values)
BeanContextBuilderpojoSwapsReplace in class BeanTraverseBuildervalues - The values to remove from this property.
PojoSwap.
SurrogateSwap.
public JsonSchemaGeneratorBuilder pojoSwapsRemove(Class<?>... values)
BeanContextBuilderpojoSwapsRemove in class BeanTraverseBuildervalues - The values to remove from this property.
PojoSwap.
SurrogateSwap.
public JsonSchemaGeneratorBuilder pojoSwapsRemove(Object... values)
BeanContextBuilderpojoSwapsRemove in class BeanTraverseBuildervalues - The values to remove from this property.
PojoSwap.
SurrogateSwap.
public JsonSchemaGeneratorBuilder sortProperties(boolean value)
BeanContextBuilder
When
sortProperties in class BeanTraverseBuildervalue - The new value for this property.
public JsonSchemaGeneratorBuilder sortProperties()
BeanContextBuilder
Shortcut for calling sortProperties(.
sortProperties in class BeanTraverseBuilderpublic JsonSchemaGeneratorBuilder timeZone(TimeZone value)
BeanContextBuildertimeZone in class BeanTraverseBuildervalue - 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 BeanTraverseBuildervalue - The property value.public JsonSchemaGeneratorBuilder useEnumNames()
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString().
useEnumNames in class BeanTraverseBuilderpublic JsonSchemaGeneratorBuilder useInterfaceProxies(boolean value)
BeanContextBuilder
If InvocationHandler if there is no other way of instantiating them.
useInterfaceProxies in class BeanTraverseBuildervalue - The new value for this property.
public JsonSchemaGeneratorBuilder useJavaBeanIntrospector(boolean value)
BeanContextBuilderUsing 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 BeanTraverseBuildervalue - The new value for this property.
public JsonSchemaGeneratorBuilder useJavaBeanIntrospector()
BeanContextBuilder
Shortcut for calling useJavaBeanIntrospector(.
useJavaBeanIntrospector in class BeanTraverseBuilderpublic JsonSchemaGeneratorBuilder set(String name, Object value)
ContextBuilderset in class BeanTraverseBuildername - The property name.value - The property value.PropertyStoreBuilder.set(String, Object)public JsonSchemaGeneratorBuilder set(Map<String,Object> properties)
ContextBuilderset in class BeanTraverseBuilderproperties - The properties to set on this class.PropertyStoreBuilder.set(java.util.Map)public JsonSchemaGeneratorBuilder add(Map<String,Object> properties)
ContextBuilderadd in class BeanTraverseBuilderproperties - The properties to set on this class.PropertyStoreBuilder.add(java.util.Map)public JsonSchemaGeneratorBuilder addTo(String name, Object value)
ContextBuilderaddTo in class BeanTraverseBuildername - The property name.value - The new value to add to the SET property.public JsonSchemaGeneratorBuilder addTo(String name, String key, Object value)
ContextBuilderaddTo in class BeanTraverseBuildername - The property name.key - The property value map key.value - The property value map value.public JsonSchemaGeneratorBuilder removeFrom(String name, Object value)
ContextBuilderremoveFrom in class BeanTraverseBuildername - The property name.value - The property value in the SET property.public JsonSchemaGeneratorBuilder apply(PropertyStore copyFrom)
ContextBuilderapply in class BeanTraverseBuildercopyFrom - The factory whose settings are being copied.public JsonSchemaGeneratorBuilder applyAnnotations(AnnotationList al, VarResolverSession vrs)
ContextBuilderapplyAnnotations in class BeanTraverseBuilderal - The list of all annotations annotated with PropertyStoreApply.vrs - The string resolver for resolving variables in annotation values.public JsonSchemaGeneratorBuilder applyAnnotations(Class<?> fromClass)
ContextBuilderApplies 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 BeanTraverseBuilderfromClass - The class on which the annotations are defined.public JsonSchemaGeneratorBuilder applyAnnotations(Method fromMethod)
ContextBuilderApplies 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 BeanTraverseBuilderfromMethod - The method on which the annotations are defined.Copyright © 2016–2019 The Apache Software Foundation. All rights reserved.