com.github.i49.hibiscus.facets

Class MinLengthFacet<V extends JsonValue>

java.lang.Object

com.github.i49.hibiscus.facets.MinLengthFacet<V>

Type Parameters:

V - the type of JsonValue to which this facet will be applied.

All Implemented Interfaces:

Facet<V>

public class MinLengthFacet<V extends JsonValue>
extends Object
implements Facet<V>

minLength facet to restrict the value space to the values that have lengths more than or equal to a specific length.

This facet is applicable to string() or array() type. If the value of the type has the length shorter than the expected length, a problem will be reported by this facet. The type of the problem to be reported is determined by LengthProblemFactory which is passed in to the constructor.

Constructor Summary

Constructors

Constructor and Description
MinLengthFacet(int minLength, ToIntFunction<V> lengthMapper, LengthProblemFactory<V> problemFactory) Constructs this facet.

Method Summary

Modifier and Type	Method and Description
void	apply(V 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

MinLengthFacet

public MinLengthFacet(int minLength,
                      ToIntFunction<V> lengthMapper,
                      LengthProblemFactory<V> problemFactory)

Constructs this facet.

Parameters:

minLength - the minimum length allowed for the type.

lengthMapper - the mapper used to retrieve the length of the value.

problemFactory - the factory used to create a new problem when given value has an invalid length.

Method Detail

apply

public void apply(V 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<V extends JsonValue>

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.