org.craftercms.commons.validation.annotations.param.EsapiValidatedParam Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2007-2023 Crafter Software Corporation. All Rights Reserved.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 3 as published by
 * the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.craftercms.commons.validation.annotations.param;

import org.craftercms.commons.validation.validators.impl.EsapiValidator;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.*;

/**
 * Parameters annotated with {@link EsapiValidatedParam} will be validated by
 * {@link org.craftercms.commons.validation.validators.impl.EsapiValidator} using the
 * specified type.
 */
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = {EsapiValidator.class})
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
public @interface EsapiValidatedParam {
    String message() default "";

    Class[] groups() default { };

    Class[] payload() default { };

    EsapiValidationType type();
}