org.jsonschema2pojo.rules

Class EnumRule

java.lang.Object

org.jsonschema2pojo.rules.EnumRule

All Implemented Interfaces:

Rule<JClassContainer,JType>

public class EnumRule
extends Object
implements Rule<JClassContainer,JType>

Applies the "enum" schema rule.

See Also:

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EnumRule(RuleFactory ruleFactory)

Method Summary

Modifier and Type	Method and Description
JType	apply(String nodeName, JsonNode node, JClassContainer container, Schema schema) Applies this schema rule to take the required code generation steps.
protected String	getConstantName(String nodeName, String customName)

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumRule

protected EnumRule(RuleFactory ruleFactory)

Method Detail

apply

public JType apply(String nodeName,
                   JsonNode node,
                   JClassContainer container,
                   Schema schema)

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

A Java Enum is created, with constants for each of the enum values present in the schema. The enum name is derived from the nodeName, and the enum type itself is created as an inner class of the owning type. In the rare case that no owning type exists (the enum is the root of the schema), then the enum becomes a public class in its own right.

The actual JSON value for each enum constant is held in a property called "value" in the generated type. A static factory method fromValue(String) is added to the generated enum, and the methods are annotated to allow Jackson to marshal/unmarshal values correctly.

Specified by:

apply in interface Rule<JClassContainer,JType>

Parameters:

nodeName - the name of the property which is an "enum"

node - the enum node

container - the class container (class or package) to which this enum should be added

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

Returns:

the newly generated Java type that was created to represent the given enum

getConstantName

protected String getConstantName(String nodeName,
                                 String customName)