io.micronaut.validation.validator.Validator Maven / Gradle / Ivy
/*
* Copyright 2017-2020 original authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.micronaut.validation.validator;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.core.beans.BeanIntrospection;
import javax.validation.Constraint;
import javax.validation.ConstraintViolation;
import javax.validation.Valid;
import java.util.Set;
/**
* Extended version of the {@link javax.validation.Valid} interface for Micronaut's implementation.
*
* The {@link #getConstraintsForClass(Class)} method is not supported by the implementation.
*
* @author graemerocher
* @since 1.2
*/
public interface Validator extends javax.validation.Validator {
/**
* Annotation used to define an object as valid.
*/
String ANN_VALID = Valid.class.getName();
/**
* Annotation used to define a constraint.
*/
String ANN_CONSTRAINT = Constraint.class.getName();
/**
* Overridden variation that returns a {@link ExecutableMethodValidator}.
* @return The validator
*/
@Override
@NonNull ExecutableMethodValidator forExecutables();
@Override
@NonNull Set> validate(
@NonNull T object,
Class... groups
);
/**
* Validate the given introspection and object.
* @param introspection The introspection
* @param object The object
* @param groups The groups
* @param The object type
* @return The constraint violations
*/
@NonNull
Set> validate(
@NonNull BeanIntrospection introspection,
@NonNull T object, @Nullable Class... groups);
@Override
@NonNull Set> validateProperty(
@NonNull T object,
@NonNull String propertyName,
Class... groups
);
@Override
@NonNull Set> validateValue(
@NonNull Class beanType,
@NonNull String propertyName,
@Nullable Object value,
Class... groups
);
/**
* Constructs a new default instance. Note that the returned instance will not contain
* managed {@link io.micronaut.validation.validator.constraints.ConstraintValidator} instances and using
* {@link javax.inject.Inject} should be preferred.
*
* @return The validator.
*/
static @NonNull Validator getInstance() {
return new DefaultValidator(
new DefaultValidatorConfiguration()
);
}
}