com.github.i49.hibiscus.facets

Class PatternFacet

java.lang.Object

com.github.i49.hibiscus.facets.PatternFacet

All Implemented Interfaces:

Facet<JsonString>

public class PatternFacet
extends Object
implements Facet<JsonString>

pattern facet to restrict the value space to the values that match a specified regular expression.

This facet is applicable to string() type only. If the value of the type does not match the specified regular expression, StringPatternProblem will be reported by this facet.

Important note is that the pattern specified for this facet must be compatible with Java regular expression and not with JavaScript alternative defined in the ECMA 262 specification.

Constructor Summary

Constructors

Constructor and Description
PatternFacet(String regex) Constructs this facet.

Method Summary

Modifier and Type	Method and Description
void	apply(JsonString value, List<Problem> problems) Applies this facet to a value in JSON document and when the value is out of valid value space, it reports one or more corresponding problems.

Methods inherited from class java.lang.Object

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

Constructor Detail

PatternFacet

public PatternFacet(String regex)

Constructs this facet.

Parameters:

regex - the regular expression which strictly conforms to Java specification accurately described in Pattern class.

Throws:

PatternSyntaxException - If the expression's syntax is invalid.

See Also:

Pattern

Method Detail

apply

public void apply(JsonString value,
                  List<Problem> problems)

Description copied from interface: Facet

Applies this facet to a value in JSON document and when the value is out of valid value space, it reports one or more corresponding problems.

Specified by:

apply in interface Facet<JsonString>

Parameters:

value - JsonValue in JSON document to be validated.

problems - the list of problems to which new problems found by this facet will be added.