ninja.validation.Required Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ninja-core Show documentation

There is a newer version: 7.0.0

/**
 * Copyright (C) the original author or 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
 *
 *     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 ninja.validation;

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

/**
 * Validates that the length of the field meets the given length constraints
 *
 * @deprecated Please use Optional in controller method instead. 
 * @author James Roper
 */
@WithValidator(Validators.RequiredValidator.class)
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
@Deprecated
public @interface Required {
    /**
     * The key for the violation message
     *
     * @return The key of the violation message
     */
    String key() default "validation.required.violation";

    /**
     * Default message if the key isn't found
     *
     * @return The default message
     */
    String message() default "{0} is required";

    /**
     * The key for formatting the field
     *
     * @return The key
     */
    String fieldKey() default "";
}