org.jsonschema2pojo.rules

Class DescriptionRule

java.lang.Object

org.jsonschema2pojo.rules.DescriptionRule

All Implemented Interfaces:

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

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

Applies the "description" schema property.

See Also:

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DescriptionRule()

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

Constructor Detail

DescriptionRule

protected DescriptionRule()

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.

When a description node is found and applied with this rule, the value of the description is added as a class level JavaDoc comment.

Specified by:

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

Parameters:

nodeName - the name of the object to which this description applies

node - the "description" schema node

generatableType - comment-able code generation construct, usually a java class, which should have this description applied

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

Returns:

the JavaDoc comment created to contain the description