Class StringSchema

java.lang.Object

com.fasterxml.jackson.module.jsonSchema.jakarta.JsonSchema

com.fasterxml.jackson.module.jsonSchema.jakarta.types.SimpleTypeSchema

com.fasterxml.jackson.module.jsonSchema.jakarta.types.ValueTypeSchema

com.fasterxml.jackson.module.jsonSchema.jakarta.types.StringSchema

public class StringSchema
extends ValueTypeSchema

This represents a JsonSchema as a String

Field Summary

Fields

Modifier and Type	Field	Description
private Integer	maxLength	this defines the maximum length of the string.
private Integer	minLength	this defines the minimum length of the string.
private String	pattern	this provides a regular expression that a string instance MUST match in order to be valid.

Fields inherited from class ValueTypeSchema

enums, format

Fields inherited from class SimpleTypeSchema

defaultdefault, links, pathStart, title

Constructor Summary

Constructors

Constructor	Description
StringSchema()

Method Summary

Modifier and Type	Method	Description
protected boolean	_equals(StringSchema that)
StringSchema	asStringSchema()	Attempt to return this JsonSchema as a StringSchema
boolean	equals(Object obj)
Integer	getMaxLength()
Integer	getMinLength()
String	getPattern()
com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatTypes	getType()
boolean	isStringSchema()	determine if this JsonSchema is an StringSchema.
void	setMaxLength(Integer maxLength)
void	setMinLength(Integer minLength)
void	setPattern(String pattern)

Methods inherited from class ValueTypeSchema

_equals, asValueSchemaSchema, asValueTypeSchema, getEnums, getFormat, isValueTypeSchema, setEnums, setFormat

Methods inherited from class SimpleTypeSchema

_equals, asSimpleTypeSchema, getDefault, getLinks, getPathStart, getTitle, isSimpleTypeSchema, setDefault, setLinks, setPathStart, setTitle

Methods inherited from class JsonSchema

_equals, arraysEqual, asAnySchema, asArraySchema, asBooleanSchema, asContainerSchema, asContainerTypeSchema, asIntegerSchema, asNullSchema, asNumberSchema, asObjectSchema, asUnionTypeSchema, enrichWithBeanProperty, equals, get$ref, get$schema, getDescription, getDisallow, getExtends, getId, getReadonly, getRequired, isAnySchema, isArraySchema, isBooleanSchema, isContainerTypeSchema, isIntegerSchema, isNullSchema, isNumberSchema, isObjectSchema, isUnionTypeSchema, minimalForFormat, set$ref, set$schema, setDescription, setDisallow, setExtends, setId, setReadonly, setRequired

Methods inherited from class Object

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

Field Details

maxLength

private Integer maxLength

this defines the maximum length of the string.

minLength

private Integer minLength

this defines the minimum length of the string.

pattern

private String pattern

this provides a regular expression that a string instance MUST match in order to be valid. Regular expressions SHOULD follow the regular expression specification from ECMA 262/Perl 5

Constructor Details

StringSchema

public StringSchema()

Method Details

asStringSchema

public StringSchema asStringSchema()

Description copied from class: JsonSchema

Attempt to return this JsonSchema as a StringSchema

Overrides:

asStringSchema in class JsonSchema

Returns:

this as a StringSchema if possible, or null otherwise

getMaxLength

public Integer getMaxLength()

getMinLength

public Integer getMinLength()

getPattern

public String getPattern()

getType

public com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatTypes getType()

Specified by:

getType in class JsonSchema

isStringSchema

public boolean isStringSchema()

Description copied from class: JsonSchema

determine if this JsonSchema is an StringSchema.

Overrides:

isStringSchema in class JsonSchema

Returns:

true if this JsonSchema is an StringSchema, false otherwise

setMaxLength

public void setMaxLength(Integer maxLength)

setMinLength

public void setMinLength(Integer minLength)

setPattern

public void setPattern(String pattern)

equals

public boolean equals(Object obj)

Overrides:

equals in class ValueTypeSchema

_equals

protected boolean _equals(StringSchema that)