io.micronaut.data.annotation.DateCreated Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of micronaut-data-model Show documentation

Data Repository Support for Micronaut

The newest version!

/*
 * 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.data.annotation;

import java.lang.annotation.*;
import java.time.temporal.ChronoUnit;

/**
 * Can be applied to date type to indicate the property should be populated when it is first inserted.
 *
 * @author graemerocher
 * @since 1.0
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD, ElementType.FIELD})
@Documented
@AutoPopulated(updatable = false)
public @interface DateCreated {
    /**
     * The annotation name.
     */
    String NAME = DateCreated.class.getName();

    /**
     * Allows to truncate the auto set date value.
     *
     * @return the truncated to constant
     * @since 3.4.2
     */
    ChronoUnit truncatedTo() default ChronoUnit.FOREVER;

}