org.jsonschema2pojo.rules

Interface Rule<T,R>

Type Parameters:

T - The type of source code item on which this rule can operate

R - The type of the source code item generated by this rule

All Known Implementing Classes:

AdditionalPropertiesRule, ArrayRule, BuilderRule, CommentRule, ConstructorRule, DefaultRule, DescriptionRule, DigitsRule, DynamicPropertiesRule, EnumRule, FormatRule, JavaNameRule, MediaRule, MinimumMaximumRule, MinItemsMaxItemsRule, MinLengthMaxLengthRule, NotRequiredRule, ObjectRule, PatternRule, PropertiesRule, PropertyRule, RequiredArrayRule, RequiredRule, SchemaRule, TitleRule, TypeRule, ValidRule

public interface Rule<T,R>

Represents a JSON Schema rule (production from JSON Schema). Can be executed or 'applied' to perform the code generation steps associated with that schema rule.

Method Summary

Modifier and Type	Method and Description
R	apply(String nodeName, com.fasterxml.jackson.databind.JsonNode node, com.fasterxml.jackson.databind.JsonNode parent, T generatableType, Schema currentSchema) Add whatever Java source is required to the given generatable to represent this schema rule.

Method Detail

apply

R apply(String nodeName,
        com.fasterxml.jackson.databind.JsonNode node,
        com.fasterxml.jackson.databind.JsonNode parent,
        T generatableType,
        Schema currentSchema)

Add whatever Java source is required to the given generatable to represent this schema rule.

Parameters:

nodeName - the name of the JSON schema node

node - the JSON schema node that has caused this rule to be applied

parent - the JSON parent of node

generatableType - A code generation construct to which this rule should be applied

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

Returns:

the newly generated source code item that was added/created as a result of executing this rule