Top Description Fields Constructors Methods
org.hibernate.validator.internal.xml.config

pack-priv Class BootstrapConfigurationImpl

extends Object
implements BootstrapConfiguration
Class Inheritance
All Implemented Interfaces
jakarta.validation.BootstrapConfiguration
Imports
java.util.Collections, .EnumSet, .HashMap, .HashSet, .Map, .Set, jakarta.validation.BootstrapConfiguration, jakarta.validation.executable.ExecutableType, org.hibernate.validator.internal.util.CollectionHelper, org.hibernate.validator.internal.util.stereotypes.Immutable
Wrapper class for the bootstrap parameters defined in validation.xml
Author
Hardy Ferentschik

Field Summary

Modifier and TypeField and Description
private static final Set<ExecutableType>
ALL_VALIDATED_EXECUTABLE_TYPES

The validated executable types, when ALL is given.

private final String
clockProviderClassName

private final Set<String>
constraintMappingResourcePaths

private final String
constraintValidatorFactoryClassName

private static final BootstrapConfiguration
DEFAULT_BOOTSTRAP_CONFIGURATION

private static final Set<ExecutableType>
DEFAULT_VALIDATED_EXECUTABLE_TYPES

The executable types validated by default.

private final String
defaultProviderClassName

private final boolean
isExecutableValidationEnabled

private final String
messageInterpolatorClassName

private final String
parameterNameProviderClassName

private final Map<String, String>
properties

private final String
traversableResolverClassName

private final Set<ExecutableType>
validatedExecutableTypes

private final Set<String>
valueExtractorClassNames

Constructor Summary

AccessConstructor and Description
private
BootstrapConfigurationImpl()

public
BootstrapConfigurationImpl(String defaultProviderClassName, String constraintValidatorFactoryClassName, String messageInterpolatorClassName, String traversableResolverClassName, String parameterNameProviderClassName, String clockProviderClassName, Set<String> valueExtractorClassNames, EnumSet<ExecutableType> validatedExecutableTypes, boolean isExecutableValidationEnabled, Set<String> constraintMappingResourcePaths, Map<String, String> properties)

Method Summary

Modifier and TypeMethod and Description
public String
getClockProviderClassName()

Implements jakarta.validation.BootstrapConfiguration.getClockProviderClassName.

Class name of the ClockProvider implementation or null if none is specified.
public Set<String>
getConstraintMappingResourcePaths()

Implements jakarta.validation.BootstrapConfiguration.getConstraintMappingResourcePaths.

Returns a set of resource paths pointing to XML constraint mapping files.
public String
getConstraintValidatorFactoryClassName()

Implements jakarta.validation.BootstrapConfiguration.getConstraintValidatorFactoryClassName.

Class name of the ConstraintValidatorFactory implementation or null if none is specified.
public static BootstrapConfiguration
getDefaultBootstrapConfiguration()

public String
getDefaultProviderClassName()

Implements jakarta.validation.BootstrapConfiguration.getDefaultProviderClassName.

Class name of the ValidationProvider implementation or null if none is specified.
public Set<ExecutableType>
getDefaultValidatedExecutableTypes()

Implements jakarta.validation.BootstrapConfiguration.getDefaultValidatedExecutableTypes.

Returns the set of executable types that should be considered unless explicitly overridden via ValidateOnExecution.
public String
getMessageInterpolatorClassName()

Implements jakarta.validation.BootstrapConfiguration.getMessageInterpolatorClassName.

Class name of the MessageInterpolator implementation or null if none is specified.
public String
getParameterNameProviderClassName()

Implements jakarta.validation.BootstrapConfiguration.getParameterNameProviderClassName.

Class name of the ParameterNameProvider implementation or null if none is specified.
public Map<String, String>
getProperties()

Implements jakarta.validation.BootstrapConfiguration.getProperties.

Returns properties as a map of string based key/value pairs.
public String
getTraversableResolverClassName()

Implements jakarta.validation.BootstrapConfiguration.getTraversableResolverClassName.

Class name of the TraversableResolver implementation or null if none is specified.
public Set<String>
getValueExtractorClassNames()

Implements jakarta.validation.BootstrapConfiguration.getValueExtractorClassNames.

Returns the class names of ValueExtractors.
public boolean
isExecutableValidationEnabled()

Implements jakarta.validation.BootstrapConfiguration.isExecutableValidationEnabled.

Returns true if the validation execution is explicitly marked as enabled or if it is left undefined.
private Set<ExecutableType>
prepareValidatedExecutableTypes(EnumSet<ExecutableType> validatedExecutableTypes)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

ALL_VALIDATED_EXECUTABLE_TYPESback to summary
private static final Set<ExecutableType> ALL_VALIDATED_EXECUTABLE_TYPES

The validated executable types, when ALL is given.

Annotations
@Immutable
clockProviderClassNameback to summary
private final String clockProviderClassName
constraintMappingResourcePathsback to summary
private final Set<String> constraintMappingResourcePaths
constraintValidatorFactoryClassNameback to summary
private final String constraintValidatorFactoryClassName
DEFAULT_BOOTSTRAP_CONFIGURATIONback to summary
private static final BootstrapConfiguration DEFAULT_BOOTSTRAP_CONFIGURATION
DEFAULT_VALIDATED_EXECUTABLE_TYPESback to summary
private static final Set<ExecutableType> DEFAULT_VALIDATED_EXECUTABLE_TYPES

The executable types validated by default.

Annotations
@Immutable
defaultProviderClassNameback to summary
private final String defaultProviderClassName
isExecutableValidationEnabledback to summary
private final boolean isExecutableValidationEnabled
messageInterpolatorClassNameback to summary
private final String messageInterpolatorClassName
parameterNameProviderClassNameback to summary
private final String parameterNameProviderClassName
propertiesback to summary
private final Map<String, String> properties
traversableResolverClassNameback to summary
private final String traversableResolverClassName
validatedExecutableTypesback to summary
private final Set<ExecutableType> validatedExecutableTypes
valueExtractorClassNamesback to summary
private final Set<String> valueExtractorClassNames

Constructor Detail

BootstrapConfigurationImplback to summary
private BootstrapConfigurationImpl()
BootstrapConfigurationImplback to summary
public BootstrapConfigurationImpl(String defaultProviderClassName, String constraintValidatorFactoryClassName, String messageInterpolatorClassName, String traversableResolverClassName, String parameterNameProviderClassName, String clockProviderClassName, Set<String> valueExtractorClassNames, EnumSet<ExecutableType> validatedExecutableTypes, boolean isExecutableValidationEnabled, Set<String> constraintMappingResourcePaths, Map<String, String> properties)

Method Detail

getClockProviderClassNameback to summary
public String getClockProviderClassName()

Implements jakarta.validation.BootstrapConfiguration.getClockProviderClassName.

Doc from jakarta.validation.BootstrapConfiguration.getClockProviderClassName.

Class name of the ClockProvider implementation or null if none is specified.

Returns:String

clock provider class name or null

Annotations
@Override
getConstraintMappingResourcePathsback to summary
public Set<String> getConstraintMappingResourcePaths()

Implements jakarta.validation.BootstrapConfiguration.getConstraintMappingResourcePaths.

Doc from jakarta.validation.BootstrapConfiguration.getConstraintMappingResourcePaths.

Returns a set of resource paths pointing to XML constraint mapping files. The set is empty if none are specified.

Returns:Set<String>

set of constraint mapping resource paths

Annotations
@Override
getConstraintValidatorFactoryClassNameback to summary
public String getConstraintValidatorFactoryClassName()

Implements jakarta.validation.BootstrapConfiguration.getConstraintValidatorFactoryClassName.

Doc from jakarta.validation.BootstrapConfiguration.getConstraintValidatorFactoryClassName.

Class name of the ConstraintValidatorFactory implementation or null if none is specified.

Returns:String

constraint validator factory class name or null

Annotations
@Override
getDefaultBootstrapConfigurationback to summary
public static BootstrapConfiguration getDefaultBootstrapConfiguration()
getDefaultProviderClassNameback to summary
public String getDefaultProviderClassName()

Implements jakarta.validation.BootstrapConfiguration.getDefaultProviderClassName.

Doc from jakarta.validation.BootstrapConfiguration.getDefaultProviderClassName.

Class name of the ValidationProvider implementation or null if none is specified.

Returns:String

validation provider class name or null

Annotations
@Override
getDefaultValidatedExecutableTypesback to summary
public Set<ExecutableType> getDefaultValidatedExecutableTypes()

Implements jakarta.validation.BootstrapConfiguration.getDefaultValidatedExecutableTypes.

Doc from jakarta.validation.BootstrapConfiguration.getDefaultValidatedExecutableTypes.

Returns the set of executable types that should be considered unless explicitly overridden via ValidateOnExecution.

Returns a set containing ExecutableType#CONSTRUCTORS and ExecutableType#NON_GETTER_METHODS if unspecified in the configuration.

Returns:Set<ExecutableType>

set of validated executable types

Annotations
@Override
getMessageInterpolatorClassNameback to summary
public String getMessageInterpolatorClassName()

Implements jakarta.validation.BootstrapConfiguration.getMessageInterpolatorClassName.

Doc from jakarta.validation.BootstrapConfiguration.getMessageInterpolatorClassName.

Class name of the MessageInterpolator implementation or null if none is specified.

Returns:String

message interpolator class name or null

Annotations
@Override
getParameterNameProviderClassNameback to summary
public String getParameterNameProviderClassName()

Implements jakarta.validation.BootstrapConfiguration.getParameterNameProviderClassName.

Doc from jakarta.validation.BootstrapConfiguration.getParameterNameProviderClassName.

Class name of the ParameterNameProvider implementation or null if none is specified.

Returns:String

parameter name provider class name or null

Annotations
@Override
getPropertiesback to summary
public Map<String, String> getProperties()

Implements jakarta.validation.BootstrapConfiguration.getProperties.

Doc from jakarta.validation.BootstrapConfiguration.getProperties.

Returns properties as a map of string based key/value pairs. The map is empty if no property has been specified.

Returns:Map<String, String>

the properties map

Annotations
@Override
getTraversableResolverClassNameback to summary
public String getTraversableResolverClassName()

Implements jakarta.validation.BootstrapConfiguration.getTraversableResolverClassName.

Doc from jakarta.validation.BootstrapConfiguration.getTraversableResolverClassName.

Class name of the TraversableResolver implementation or null if none is specified.

Returns:String

traversable resolver class name or null

Annotations
@Override
getValueExtractorClassNamesback to summary
public Set<String> getValueExtractorClassNames()

Implements jakarta.validation.BootstrapConfiguration.getValueExtractorClassNames.

Doc from jakarta.validation.BootstrapConfiguration.getValueExtractorClassNames.

Returns the class names of ValueExtractors.

Returns:Set<String>

the value extractor class names or an empty set if none are specified

Annotations
@Override
isExecutableValidationEnabledback to summary
public boolean isExecutableValidationEnabled()

Implements jakarta.validation.BootstrapConfiguration.isExecutableValidationEnabled.

Doc from jakarta.validation.BootstrapConfiguration.isExecutableValidationEnabled.

Returns true if the validation execution is explicitly marked as enabled or if it is left undefined.

Returns:boolean

whether validation execution is globally enabled

Annotations
@Override
prepareValidatedExecutableTypesback to summary
private Set<ExecutableType> prepareValidatedExecutableTypes(EnumSet<ExecutableType> validatedExecutableTypes)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override