io.permazen.annotation.JTransient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of permazen-main Show documentation

Permazen classes that map Java model classes onto the core API.

There is a newer version: 5.1.0


/*
 * Copyright (C) 2015 Archie L. Cobbs. All rights reserved.
 */

package io.permazen.annotation;

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;

/**
 * Eliminates the annotated method from consideration for Permazen field auto-generation.
 *
 * 
 * This annotation is ignored on methods that also have a {@link JField @JField}, {@link JSetField @JSetField},
 * {@link JListField @JListField}, or {@link JMapField @JMapField} annotation.
 *
 * 

 * It is only useful on non-abstract methods in classes for which both {@link PermazenType#autogenFields}
 * and {@link PermazenType#autogenNonAbstract} are true.
 *
 * 
Meta-Annotations
 *
 * 
 * This annotation may be configured indirectly as a Spring
 * meta-annotation
 * when {@code spring-core} is on the classpath.
 *
 * @see PermazenType#autogenFields
 * @see PermazenType#autogenNonAbstract
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.ANNOTATION_TYPE, ElementType.METHOD })
@Documented
public @interface JTransient {
}