Package org.everit.json.schema

Class ObjectSchema.Builder

java.lang.Object

org.everit.json.schema.Schema.Builder<ObjectSchema>

org.everit.json.schema.ObjectSchema.Builder

Enclosing class:

ObjectSchema

public static class ObjectSchema.Builder
extends Schema.Builder<ObjectSchema>

Builder class for ObjectSchema.

Field Summary

Fields inherited from class org.everit.json.schema.Schema.Builder

unprocessedProperties

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ObjectSchema.Builder	additionalProperties(boolean additionalProperties)
ObjectSchema.Builder	addPropertySchema(java.lang.String propName, Schema schema)	Adds a property schema.
ObjectSchema.Builder	addRequiredProperty(java.lang.String propertyName)
ObjectSchema	build()
ObjectSchema.Builder	maxProperties(java.lang.Integer maxProperties)
ObjectSchema.Builder	minProperties(java.lang.Integer minProperties)
ObjectSchema.Builder	patternProperty(java.lang.String pattern, Schema schema)	Deprecated.
ObjectSchema.Builder	patternProperty(java.util.regex.Pattern pattern, Schema schema)	Deprecated.
ObjectSchema.Builder	patternProperty(Regexp pattern, Schema schema)
ObjectSchema.Builder	propertyDependency(java.lang.String ifPresent, java.lang.String mustBePresent)	Adds a property dependency.
ObjectSchema.Builder	propertyNameSchema(Schema propertyNameSchema)
ObjectSchema.Builder	requiresObject(boolean requiresObject)
ObjectSchema.Builder	schemaDependency(java.lang.String ifPresent, Schema expectedSchema)
ObjectSchema.Builder	schemaOfAdditionalProperties(Schema schemaOfAdditionalProperties)

Methods inherited from class org.everit.json.schema.Schema.Builder

defaultValue, description, id, nullable, readOnly, schemaLocation, schemaLocation, title, unprocessedProperties, writeOnly

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

additionalProperties

public ObjectSchema.Builder additionalProperties(boolean additionalProperties)

addPropertySchema

public ObjectSchema.Builder addPropertySchema(java.lang.String propName,
                                              Schema schema)

Adds a property schema.

Parameters:

propName - the name of the property which' expected schema must be schema

schema - if the subject under validation has a property named propertyName then its value will be validated using this schema

Returns:

this

addRequiredProperty

public ObjectSchema.Builder addRequiredProperty(java.lang.String propertyName)

build

public ObjectSchema build()

Specified by:

build in class Schema.Builder<ObjectSchema>

maxProperties

public ObjectSchema.Builder maxProperties(java.lang.Integer maxProperties)

minProperties

public ObjectSchema.Builder minProperties(java.lang.Integer minProperties)

patternProperty

@Deprecated
public ObjectSchema.Builder patternProperty(java.util.regex.Pattern pattern,
                                            Schema schema)

Deprecated.

patternProperty

@Deprecated
public ObjectSchema.Builder patternProperty(java.lang.String pattern,
                                            Schema schema)

Deprecated.

patternProperty

public ObjectSchema.Builder patternProperty(Regexp pattern,
                                            Schema schema)

propertyDependency

public ObjectSchema.Builder propertyDependency(java.lang.String ifPresent,
                                               java.lang.String mustBePresent)

Adds a property dependency.

Parameters:

ifPresent - the name of the property which if is present then a property with name mustBePresent is mandatory

mustBePresent - a property with this name must exist in the subject under validation if a property named ifPresent exists

Returns:

this

requiresObject

public ObjectSchema.Builder requiresObject(boolean requiresObject)

schemaDependency

public ObjectSchema.Builder schemaDependency(java.lang.String ifPresent,
                                             Schema expectedSchema)

schemaOfAdditionalProperties

public ObjectSchema.Builder schemaOfAdditionalProperties(Schema schemaOfAdditionalProperties)

propertyNameSchema

public ObjectSchema.Builder propertyNameSchema(Schema propertyNameSchema)