com.mongodb.internal.validator

Class MappedFieldNameValidator

java.lang.Object

com.mongodb.internal.validator.MappedFieldNameValidator

All Implemented Interfaces:

FieldNameValidator

public class MappedFieldNameValidator
extends java.lang.Object
implements FieldNameValidator

A field name validator that serves as a root validator for a map of validators that are applied to child fields. Note that instances of this class can be nested to achieve a wide variety of validation behaviors.

This class should not be considered a part of the public API.

Constructor Summary

Constructors

Constructor and Description
MappedFieldNameValidator(FieldNameValidator defaultValidator, java.util.Map<java.lang.String,FieldNameValidator> fieldNameToValidatorMap) The default validator will be use to validate all fields whose names are not contained int the fieldNameToValidator map.

Method Summary

Modifier and Type	Method and Description
FieldNameValidator	getValidatorForField(java.lang.String fieldName) Gets a new validator to use for the value of the field with the given name.
boolean	validate(java.lang.String fieldName) Returns true if the field name is valid, false otherwise.

Methods inherited from class java.lang.Object

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

Constructor Detail

MappedFieldNameValidator

public MappedFieldNameValidator(FieldNameValidator defaultValidator,
                                java.util.Map<java.lang.String,FieldNameValidator> fieldNameToValidatorMap)

The default validator will be use to validate all fields whose names are not contained int the fieldNameToValidator map. The map is used to apply different validators to fields with specific names.

Parameters:

defaultValidator - the validator to use for any fields not matching any field name in the map

fieldNameToValidatorMap - a map from field name to FieldNameValidator

Method Detail

validate

public boolean validate(java.lang.String fieldName)

Description copied from interface: FieldNameValidator

Returns true if the field name is valid, false otherwise.

Specified by:

validate in interface FieldNameValidator

Parameters:

fieldName - the field name

Returns:

true if the field name is valid, false otherwise

getValidatorForField

public FieldNameValidator getValidatorForField(java.lang.String fieldName)

Description copied from interface: FieldNameValidator

Gets a new validator to use for the value of the field with the given name.

Specified by:

getValidatorForField in interface FieldNameValidator

Parameters:

fieldName - the field name

Returns:

a non-null validator