hu.icellmobilsoft.coffee.model.base.annotation.ModifiedBy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of coffee-model-base Show documentation

The newest version!

/*-
 * #%L
 * Coffee
 * %%
 * Copyright (C) 2020 i-Cell Mobilsoft Zrt.
 * %%
 * 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.
 * #L%
 */
package hu.icellmobilsoft.coffee.model.base.annotation;

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

/**
 * Marks a property who modifed
 *
 * By setting {@link #onCreate()} to {@code true}, the property gets also set when the entity is persisted.
 *
 * @author czenczl
 * @since 1.0.0
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.FIELD, ElementType.METHOD })
public @interface ModifiedBy {

    /**
     * Returns {@code true} if the field should be updated on entity creation too
     * 
     * @return {@code true} if the field should be updated on entity creation too
     */
    boolean onCreate() default false;

}