org.jsonschema2pojo.rules

Class AdditionalPropertiesRule

java.lang.Object

org.jsonschema2pojo.rules.AdditionalPropertiesRule

All Implemented Interfaces:

Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JDefinedClass>

public class AdditionalPropertiesRule
extends Object
implements Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JDefinedClass>

Applies the "additionalProperties" JSON schema rule.

See Also:

http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.6

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AdditionalPropertiesRule(RuleFactory ruleFactory)

Method Summary

Methods

Modifier and Type	Method and Description
com.sun.codemodel.JDefinedClass	apply(String nodeName, com.fasterxml.jackson.databind.JsonNode node, com.sun.codemodel.JDefinedClass jclass, Schema schema) Applies this schema rule to take the required code generation steps.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdditionalPropertiesRule

protected AdditionalPropertiesRule(RuleFactory ruleFactory)

Method Detail

apply

public com.sun.codemodel.JDefinedClass apply(String nodeName,
                                    com.fasterxml.jackson.databind.JsonNode node,
                                    com.sun.codemodel.JDefinedClass jclass,
                                    Schema schema)

Applies this schema rule to take the required code generation steps.

If additionalProperties is specified and set to the boolean value false, this rule does not make any change to the generated Java type (the type does not allow additional properties).

If the additionalProperties node is null (not specified in the schema) or empty, then a new bean property named "additionalProperties", of type Map<String,Object> is added to the generated type (with appropriate accessors). The accessors are annotated to allow unrecognised (additional) properties found in JSON data to be marshalled/unmarshalled from/to this map.

If the additionalProperties node is present and specifies a schema, then an "additionalProperties" map is added to the generated type. This time the map values will be restricted and must be instances of a newly generated Java type that will be created based on the additionalProperties schema provided. If the schema does not specify the javaType property, the name of the newly generated type will be derived from the nodeName and the suffix 'Property'.

Specified by:

apply in interface Rule<com.sun.codemodel.JDefinedClass,com.sun.codemodel.JDefinedClass>

Parameters:

nodeName - the name of the schema node for which the additionalProperties node applies

node - the additionalProperties node itself, found in the schema (may be null if not specified in the schema)

jclass - the Java type that is being generated to represent this schema

schema - the schema to which this schema rule (and the given node) belongs.

Returns:

the given Java type jclass