public @interface

Ignore

implements java.lang.annotation.Annotation

 androidx.room.Ignore

Overview

Ignores the marked element from Room's processing logic.

This annotation can be used in multiple places where Room processor runs. For instance, you can add it to a field of an Entity and Room will not persist that field.

Summary

Source

/*
 * Copyright (C) 2016 The Android Open Source Project
 *
 * 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 androidx.room;

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

/**
 * Ignores the marked element from Room's processing logic.
 * <p>
 * This annotation can be used in multiple places where Room processor runs. For instance, you can
 * add it to a field of an {@link Entity} and Room will not persist that field.
 */
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.CONSTRUCTOR})
@Retention(RetentionPolicy.CLASS)
public @interface Ignore {
}