org.jsonschema2pojo.rules

Class RuleFactory

java.lang.Object

org.jsonschema2pojo.rules.RuleFactory

public class RuleFactory
extends Object

Provides factory/creation methods for the code generation rules.

Constructor Summary

Constructors

Constructor and Description
RuleFactory() Create a rule factory with the default generation config options.
RuleFactory(GenerationConfig generationConfig, Annotator annotator, SchemaStore schemaStore) Create a new rule factory with the given generation config options.

Method Summary

Methods

Modifier and Type	Method and Description
Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JDefinedClass>	getAdditionalPropertiesRule() Provides a rule instance that should be applied when an "additionalProperties" declaration is found in the schema.
Annotator	getAnnotator() Gets the annotator that will in apply annotations to the generated code to allow correct serialization and deserialization, according to the chosen annotation style.
Rule<com.sun.codemodel.JPackage,com.sun.codemodel.JClass>	getArrayRule() Provides a rule instance that should be applied when an "array" declaration is found in the schema.
Rule<com.sun.codemodel.JFieldVar,com.sun.codemodel.JFieldVar>	getDefaultRule() Provides a rule instance that should be applied when a property declaration is found in the schema to assign any appropriate default value to that property.
Rule<com.sun.codemodel.JDocCommentable,com.sun.codemodel.JDocComment>	getDescriptionRule() Provides a rule instance that should be applied when a "description" declaration is found in the schema.
Rule<com.sun.codemodel.JClassContainer,com.sun.codemodel.JType>	getEnumRule() Provides a rule instance that should be applied when an "enum" declaration is found in the schema.
Rule<com.sun.codemodel.JType,com.sun.codemodel.JType>	getFormatRule() Provides a rule instance that should be applied when a "format" declaration is found in the schema.
GenerationConfig	getGenerationConfig() Gets the configuration options that will influence the java code generated by rules created by this factory.
Rule<com.sun.codemodel.JType,com.sun.codemodel.JType>	getMediaRule() Provides a rule instance that should be applied when a "media" declaration is found in the schema.
Rule<com.sun.codemodel.JFieldVar,com.sun.codemodel.JFieldVar>	getMinimumMaximumRule() Provides a rule instance that should be applied when a property declaration is found in the schema, to assign any minimum/maximum validation on that property
Rule<com.sun.codemodel.JFieldVar,com.sun.codemodel.JFieldVar>	getMinItemsMaxItemsRule() Provides a rule instance that should be applied when a property declaration is found in the schema, to assign any size validation (minItems/maxItems) on that property
Rule<com.sun.codemodel.JFieldVar,com.sun.codemodel.JFieldVar>	getMinLengthMaxLengthRule() Provides a rule instance that should be applied when a property declaration is found in the schema, to assign any size validation (minLength/maxLength) on that property
NameHelper	getNameHelper() Gets the name helper that is used to generate normalized Class and field names.
Rule<com.sun.codemodel.JPackage,com.sun.codemodel.JType>	getObjectRule() Provides a rule instance that should be applied when an "object" declaration is found in the schema.
Rule<com.sun.codemodel.JFieldVar,com.sun.codemodel.JFieldVar>	getPatternRule() Provides a rule instance that should be applied when a "pattern" declaration is found in the schema for a property.
Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JDefinedClass>	getPropertiesRule() Provides a rule instance that should be applied when a "properties" declaration is found in the schema.
Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JDefinedClass>	getPropertyRule() Provides a rule instance that should be applied when a property declaration (child of the "properties" declaration) is found in the schema.
Rule<com.sun.codemodel.JDocCommentable,com.sun.codemodel.JDocComment>	getRequiredRule() Provides a rule instance that should be applied when a "required" declaration is found in the schema.
Rule<com.sun.codemodel.JClassContainer,com.sun.codemodel.JType>	getSchemaRule() Provides a rule instance that should be applied when a schema declaration is found in the schema.
SchemaStore	getSchemaStore() Gets the store that finds and saves JSON schemas
Rule<com.sun.codemodel.JDocCommentable,com.sun.codemodel.JDocComment>	getTitleRule() Provides a rule instance that should be applied when a "title" declaration is found in the schema.
Rule<com.sun.codemodel.JClassContainer,com.sun.codemodel.JType>	getTypeRule() Provides a rule instance that should be applied to a node to find its equivalent Java type.
Rule<com.sun.codemodel.JFieldVar,com.sun.codemodel.JFieldVar>	getValidRule() Provides a rule instance that should be applied when a property declaration is found in the schema which itself contains properties, to assign validation of the properties within that property
void	setAnnotator(Annotator annotator) The annotator used to mark up Java types with any annotations that are required to build JSON compatible types
void	setGenerationConfig(GenerationConfig generationConfig) The generation config options for type generation.
void	setSchemaStore(SchemaStore schemaStore) The object used by this factory to get and store schemas

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RuleFactory

public RuleFactory(GenerationConfig generationConfig,
           Annotator annotator,
           SchemaStore schemaStore)

Create a new rule factory with the given generation config options.

Parameters:

generationConfig - The generation config options for type generation. These config options will influence the java code generated by rules created by this factory.

annotator - the annotator used to mark up Java types with any annotations that are required to build JSON compatible types

schemaStore - the object used by this factory to get and store schemas

RuleFactory

public RuleFactory()

Create a rule factory with the default generation config options.

See Also:

DefaultGenerationConfig

Method Detail

getArrayRule

public Rule<com.sun.codemodel.JPackage,com.sun.codemodel.JClass> getArrayRule()

Provides a rule instance that should be applied when an "array" declaration is found in the schema.

Returns:

a schema rule that can handle the "array" declaration.

getDescriptionRule

public Rule<com.sun.codemodel.JDocCommentable,com.sun.codemodel.JDocComment> getDescriptionRule()

Provides a rule instance that should be applied when a "description" declaration is found in the schema.

Returns:

a schema rule that can handle the "description" declaration.

getEnumRule

public Rule<com.sun.codemodel.JClassContainer,com.sun.codemodel.JType> getEnumRule()

Provides a rule instance that should be applied when an "enum" declaration is found in the schema.

Returns:

a schema rule that can handle the "enum" declaration.

getFormatRule

public Rule<com.sun.codemodel.JType,com.sun.codemodel.JType> getFormatRule()

Provides a rule instance that should be applied when a "format" declaration is found in the schema.

Returns:

a schema rule that can handle the "format" declaration.

getObjectRule

public Rule<com.sun.codemodel.JPackage,com.sun.codemodel.JType> getObjectRule()

Provides a rule instance that should be applied when an "object" declaration is found in the schema.

Returns:

a schema rule that can handle the "object" declaration.

getPropertiesRule

public Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JDefinedClass> getPropertiesRule()

Provides a rule instance that should be applied when a "properties" declaration is found in the schema.

Returns:

a schema rule that can handle the "properties" declaration.

getPropertyRule

public Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JDefinedClass> getPropertyRule()

Provides a rule instance that should be applied when a property declaration (child of the "properties" declaration) is found in the schema.

Returns:

a schema rule that can handle a property declaration.

getRequiredRule

public Rule<com.sun.codemodel.JDocCommentable,com.sun.codemodel.JDocComment> getRequiredRule()

Provides a rule instance that should be applied when a "required" declaration is found in the schema.

Returns:

a schema rule that can handle the "required" declaration.

getTypeRule

public Rule<com.sun.codemodel.JClassContainer,com.sun.codemodel.JType> getTypeRule()

Provides a rule instance that should be applied to a node to find its equivalent Java type. Typically invoked for properties, arrays, etc for which a Java type must be found/generated.

Returns:

a schema rule that can find/generate the relevant Java type for a given schema node.

getAdditionalPropertiesRule

public Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JDefinedClass> getAdditionalPropertiesRule()

Provides a rule instance that should be applied when an "additionalProperties" declaration is found in the schema.

Returns:

a schema rule that can handle the "additionalProperties" declaration.

getTitleRule

public Rule<com.sun.codemodel.JDocCommentable,com.sun.codemodel.JDocComment> getTitleRule()

Provides a rule instance that should be applied when a "title" declaration is found in the schema.

Returns:

a schema rule that can handle the "title" declaration.

getSchemaRule

public Rule<com.sun.codemodel.JClassContainer,com.sun.codemodel.JType> getSchemaRule()

Provides a rule instance that should be applied when a schema declaration is found in the schema.

Returns:

a schema rule that can handle a schema declaration.

getDefaultRule

public Rule<com.sun.codemodel.JFieldVar,com.sun.codemodel.JFieldVar> getDefaultRule()

Provides a rule instance that should be applied when a property declaration is found in the schema to assign any appropriate default value to that property.

Returns:

a schema rule that can handle the "default" declaration.

getMinimumMaximumRule

public Rule<com.sun.codemodel.JFieldVar,com.sun.codemodel.JFieldVar> getMinimumMaximumRule()

Provides a rule instance that should be applied when a property declaration is found in the schema, to assign any minimum/maximum validation on that property

Returns:

a schema rule that can handle the "default" declaration.

getMinItemsMaxItemsRule

public Rule<com.sun.codemodel.JFieldVar,com.sun.codemodel.JFieldVar> getMinItemsMaxItemsRule()

Provides a rule instance that should be applied when a property declaration is found in the schema, to assign any size validation (minItems/maxItems) on that property

Returns:

a schema rule that can handle the "default" declaration.

getMinLengthMaxLengthRule

public Rule<com.sun.codemodel.JFieldVar,com.sun.codemodel.JFieldVar> getMinLengthMaxLengthRule()

Provides a rule instance that should be applied when a property declaration is found in the schema, to assign any size validation (minLength/maxLength) on that property

Returns:

a schema rule that can handle the "default" declaration.

getPatternRule

public Rule<com.sun.codemodel.JFieldVar,com.sun.codemodel.JFieldVar> getPatternRule()

Provides a rule instance that should be applied when a "pattern" declaration is found in the schema for a property.

Returns:

a schema rule that can handle the "pattern" declaration.

getValidRule

public Rule<com.sun.codemodel.JFieldVar,com.sun.codemodel.JFieldVar> getValidRule()

Provides a rule instance that should be applied when a property declaration is found in the schema which itself contains properties, to assign validation of the properties within that property

Returns:

a schema rule that can handle the "default" declaration.

getGenerationConfig

public GenerationConfig getGenerationConfig()

Gets the configuration options that will influence the java code generated by rules created by this factory.

Returns:

A configuration object containing all configuration property values.

setGenerationConfig

public void setGenerationConfig(GenerationConfig generationConfig)

The generation config options for type generation. These config options will influence the java code generated by rules created by this factory.

Parameters:

generationConfig - Generation config

getAnnotator

public Annotator getAnnotator()

Gets the annotator that will in apply annotations to the generated code to allow correct serialization and deserialization, according to the chosen annotation style.

Returns:

an annotator that can annotate various code constructs for JSON support

setAnnotator

public void setAnnotator(Annotator annotator)

The annotator used to mark up Java types with any annotations that are required to build JSON compatible types

Parameters:

annotator - the annotator

getSchemaStore

public SchemaStore getSchemaStore()

Gets the store that finds and saves JSON schemas

Returns:

a store that finds and caches schema objects during type generation.

setSchemaStore

public void setSchemaStore(SchemaStore schemaStore)

The object used by this factory to get and store schemas

Parameters:

schemaStore - schema store

getNameHelper

public NameHelper getNameHelper()

Gets the name helper that is used to generate normalized Class and field names.

Returns:

a name helper instance that can be used to normalize Class and field names.

getMediaRule

public Rule<com.sun.codemodel.JType,com.sun.codemodel.JType> getMediaRule()

Provides a rule instance that should be applied when a "media" declaration is found in the schema.

Returns:

a schema rule that can handle the "media" declaration.