org.jsonschema2pojo.rules

Class FormatRule

java.lang.Object

org.jsonschema2pojo.rules.FormatRule

All Implemented Interfaces:

Rule<com.sun.codemodel.JType,com.sun.codemodel.JType>

public class FormatRule
extends Object
implements Rule<com.sun.codemodel.JType,com.sun.codemodel.JType>

Applies the "format" schema rule.

See Also:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ISO_8601_DATE_FORMAT
static String	ISO_8601_DATETIME_FORMAT
static String	ISO_8601_TIME_FORMAT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FormatRule(RuleFactory ruleFactory)

Method Summary

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

ISO_8601_DATE_FORMAT

public static String ISO_8601_DATE_FORMAT

ISO_8601_TIME_FORMAT

public static String ISO_8601_TIME_FORMAT

ISO_8601_DATETIME_FORMAT

public static String ISO_8601_DATETIME_FORMAT

Constructor Detail

FormatRule

protected FormatRule(RuleFactory ruleFactory)

Method Detail

apply

public com.sun.codemodel.JType apply(String nodeName,
                                     com.fasterxml.jackson.databind.JsonNode node,
                                     com.sun.codemodel.JType baseType,
                                     Schema schema)

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

This rule maps format values to Java types:

• "format":"date-time" => Date or DateTime (if config useJodaDates is set)
• "format":"date" => String or LocalDate (if config useJodaLocalDates is set)
• "format":"time" => String or LocalTime (if config useJodaLocalTimes is set)
• "format":"utc-millisec" => long
• "format":"regex" => Pattern
• "format":"color" => String
• "format":"style" => String
• "format":"phone" => String
• "format":"uri" => URI
• "format":"email" => String
• "format":"ip-address" => String
• "format":"ipv6" => String
• "format":"host-name" => String
• "format":"uuid" => UUID
• other (unrecognised format) => baseType

Specified by:

apply in interface Rule<com.sun.codemodel.JType,com.sun.codemodel.JType>

Parameters:

nodeName - the name of the node to which this format is applied

node - the format node

baseType - the type which which is being formatted e.g. for { "type" : "string", "format" : "uri" } the baseType would be java.lang.String

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

Returns:

the Java type that is appropriate for the format value