com.github.robtimus.validation.time.precision.MicrosecondPrecision Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of time-precision-validation Show documentation
Contains validation constraints for time precision of date/time objects
The newest version!
/*
 * MicrosecondPrecision.java
 * Copyright 2021 Rob Spoor
 *
 * 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.github.robtimus.validation.time.precision;

import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
import static java.lang.annotation.ElementType.CONSTRUCTOR;
import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.ElementType.TYPE_USE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
import java.lang.annotation.Documented;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import java.time.temporal.ChronoField;
import java.time.temporal.TemporalAccessor;
import java.time.temporal.TemporalField;
import jakarta.validation.Constraint;
import jakarta.validation.Payload;
import com.github.robtimus.validation.time.precision.MicrosecondPrecision.List;
import com.github.robtimus.validation.time.precision.validators.MicrosecondPrecisionValidator;

/**
 * Validates that a date/time object should have microsecond precision.
 * More specifically, for a date/time object {@code object}, validates that {@code object.nanosecond % 1000 == 0}.
 * 
 * Supported types are:
 * 

 * {@link java.time.temporal.TemporalAccessor}, as long as the implementation supports {@link ChronoField#NANO_OF_SECOND} as argument for
 *     {@link TemporalAccessor#get(TemporalField)}
 * 
 * Note that {@link java.util.Date} and {@link java.util.Calendar} already have millisecond precision, which implies microsecond precision; as a
 * result these types are not supported.
 * 
 * {@code null} elements are considered valid.
 *
 * @author Rob Spoor
 */
@Documented
@Constraint(validatedBy = MicrosecondPrecisionValidator.ForTemporalAccessor.class)
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Repeatable(List.class)
public @interface MicrosecondPrecision {

    /**
     * The error message.
     */
    String message() default "{com.github.robtimus.validation.time.precision.MicrosecondPrecision.message}";

    /**
     * The validation groups.
     */
    Class[] groups() default { };

    /**
     * The payload.
     */
    Class[] payload() default { };

    /**
     * Defines several {@link MicrosecondPrecision} annotations on the same element.
     */
    @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
    @Retention(RUNTIME)
    @Documented
    public @interface List {

        /**
         * The {@link MicrosecondPrecision} annotations.
         */
        MicrosecondPrecision[] value();
    }
}