org.jsimpledb.annotation.JTransient Maven / Gradle / Ivy

Go to download

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

package org.jsimpledb.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 JSimpleDB 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 JSimpleClass#autogenFields}
 * and {@link JSimpleClass#autogenNonAbstract} are true.
 *
 * @see JSimpleClass#autogenFields
 * @see JSimpleClass#autogenNonAbstract
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface JTransient {
}