com.wl4g.infra.common.validation.EnumValue Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of infra-common Show documentation

A Infra Common.

There is a newer version: 3.1.72

/*
 * Copyright 2017 ~ 2025 the original author or authors. James Wong 
 *
 * 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
 *
 *      http://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 com.wl4g.infra.common.validation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import javax.validation.Constraint;
import javax.validation.Payload;

/**
 * {@link EnumValue}
 * 
 * @author James Wong
 * @version 2022-09-16
 * @since v3.0.0
 */
@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.ANNOTATION_TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = { EnumValidator.class })
@Documented
public @interface EnumValue {

    String message() default "invalid enum type";

    Class[] groups() default {};

    Class[] payload() default {};

    boolean caseSensitive() default false;

    Class[] enumCls() default {};

    String enumField() default "";
}