org.jsonschema2pojo.rules

Class RequiredRule

java.lang.Object

org.jsonschema2pojo.rules.RequiredRule

All Implemented Interfaces:

Rule<com.sun.codemodel.JDocCommentable,com.sun.codemodel.JDocComment>

public class RequiredRule
extends Object
implements Rule<com.sun.codemodel.JDocCommentable,com.sun.codemodel.JDocComment>

Applies the "required" schema rule.

See Also:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	REQUIRED_COMMENT_TEXT Text added to JavaDoc to indicate that a field is required

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RequiredRule(RuleFactory ruleFactory)

Method Summary

Methods

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

Field Detail

REQUIRED_COMMENT_TEXT

public static final String REQUIRED_COMMENT_TEXT

Text added to JavaDoc to indicate that a field is required

See Also:

Constant Field Values

Constructor Detail

RequiredRule

protected RequiredRule(RuleFactory ruleFactory)

Method Detail

apply

public com.sun.codemodel.JDocComment apply(String nodeName,
                                  com.fasterxml.jackson.databind.JsonNode node,
                                  com.sun.codemodel.JDocCommentable generatableType,
                                  Schema schema)

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

The required rule simply adds a note to the JavaDoc comment to mark a property as required.

Specified by:

apply in interface Rule<com.sun.codemodel.JDocCommentable,com.sun.codemodel.JDocComment>

Parameters:

nodeName - the name of the schema node for which this "required" rule has been added

node - the "required" node, having a value true or false

generatableType - the class or method which may be marked as "required"

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

Returns:

the JavaDoc comment attached to the generatableType, which may have an added not to mark this construct as required.