org.jsonschema2pojo.rules

Class ArrayRule

java.lang.Object

org.jsonschema2pojo.rules.ArrayRule

All Implemented Interfaces:

Rule<com.sun.codemodel.JPackage,com.sun.codemodel.JClass>

public class ArrayRule
extends Object
implements Rule<com.sun.codemodel.JPackage,com.sun.codemodel.JClass>

Applies the "type":"array" schema rule.

See Also:

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ArrayRule(RuleFactory ruleFactory)

Method Summary

Methods

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

ArrayRule

protected ArrayRule(RuleFactory ruleFactory)

Method Detail

apply

public com.sun.codemodel.JClass apply(String nodeName,
                             com.fasterxml.jackson.databind.JsonNode node,
                             com.sun.codemodel.JPackage jpackage,
                             Schema schema)

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

When constructs of type "array" appear in the schema, these are mapped to Java collections in the generated POJO. If the array is marked as having "uniqueItems" then the resulting Java type is Set, if not, then the resulting Java type is List. The schema given by "items" will decide the generic type of the collection.

If the "items" property requires newly generated types, then the type name will be the singular version of the nodeName (unless overridden by the javaType property) e.g.

  "fooBars" : {"type":"array", "uniqueItems":"true", "items":{type:"object"}}
  ==>
  Set<FooBar> getFooBars(); 
 

Specified by:

apply in interface Rule<com.sun.codemodel.JPackage,com.sun.codemodel.JClass>

Parameters:

nodeName - the name of the property which has type "array"

node - the schema "type" node

jpackage - the package into which newly generated types should be added

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

Returns:

the Java type associated with this array rule, either Set or List, narrowed by the "items" type