org.jsonschema2pojo.rules

Class PropertyRule

java.lang.Object

org.jsonschema2pojo.rules.PropertyRule

All Implemented Interfaces:

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

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

Applies the schema rules that represent a property definition.

See Also:

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PropertyRule(RuleFactory ruleFactory)

Method Summary

Modifier and Type	Method and Description
com.sun.codemodel.JDefinedClass	apply(String nodeName, com.fasterxml.jackson.databind.JsonNode node, com.fasterxml.jackson.databind.JsonNode parent, 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

PropertyRule

protected PropertyRule(RuleFactory ruleFactory)

Method Detail

apply

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

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

This rule adds a property to a given Java class according to the Java Bean spec. A private field is added to the class, along with accompanying accessor methods.

If this rule's schema mapper is configured to include builder methods (see GenerationConfig.isGenerateBuilders() ), then a builder method of the form withFoo(Foo foo); is also added.

Specified by:

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

Parameters:

nodeName - the name of the property to be applied

node - the node describing the characteristics of this property

parent - the parent node

jclass - the Java class which should have this property added

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

Returns:

the given jclass