org.jsonschema2pojo.rules

Class DynamicPropertiesRule

java.lang.Object

org.jsonschema2pojo.rules.DynamicPropertiesRule

All Implemented Interfaces:

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

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

Adds methods for dynamically getting, setting, and building properties.

Author:

Christian Trimble

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUILDER_NAME
static String	DEFINED_GETTER_NAME
static String	DEFINED_SETTER_NAME
static String	GETTER_NAME
static String	NOT_FOUND_VALUE_FIELD
static String	SETTER_NAME

Constructor Summary

Constructors

Constructor and Description
DynamicPropertiesRule(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 currentSchema) This rule adds dynamic getter, setter and builder methods based on the properties and additional properties defined in a schema.

Methods inherited from class java.lang.Object

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

Field Detail

NOT_FOUND_VALUE_FIELD

public static final String NOT_FOUND_VALUE_FIELD

See Also:

Constant Field Values

SETTER_NAME

public static final String SETTER_NAME

See Also:

Constant Field Values

GETTER_NAME

public static final String GETTER_NAME

See Also:

Constant Field Values

BUILDER_NAME

public static final String BUILDER_NAME

See Also:

Constant Field Values

DEFINED_SETTER_NAME

public static final String DEFINED_SETTER_NAME

See Also:

Constant Field Values

DEFINED_GETTER_NAME

public static final String DEFINED_GETTER_NAME

See Also:

Constant Field Values

Constructor Detail

DynamicPropertiesRule

public DynamicPropertiesRule(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 currentSchema)

This rule adds dynamic getter, setter and builder methods based on the properties and additional properties defined in a schema.

If accessors are being generated, then methods for getting and setting properties by name will be added. These methods first attempt to call the appropriate getter or setter for the property. If the named property is not defined, then the additional properties map is used.

If builders are being generated, then a method for building properties by name will be added. This method first attempts to call the builder for the property. If no property with the supplied name is defined, then the additional properties map is used.

The methods generated by this class throw an IllegalArgumentException, if the name specified for the property is unknown and additional properties are not enabled. A ClassCastException will be thrown, when the value being set is incompatible with the type of the named property.

Specified by:

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

Parameters:

nodeName - the name of the node for which dynamic getters, setters, and builders are being added.

node - the properties node, containing property names and their definition

parent - the parent node

jclass - the Java type which will have the given properties added

currentSchema - the schema being implemented

Returns:

the given jclass