Home | History | Annotate | Download | only in room
      1 /*
      2  * Copyright (C) 2016 The Android Open Source Project
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  *      http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 
     17 package androidx.room;
     18 
     19 import java.lang.annotation.ElementType;
     20 import java.lang.annotation.Retention;
     21 import java.lang.annotation.RetentionPolicy;
     22 import java.lang.annotation.Target;
     23 
     24 /**
     25  * Marks the class as a Data Access Object.
     26  * <p>
     27  * Data Access Objects are the main classes where you define your database interactions. They can
     28  * include a variety of query methods.
     29  * <p>
     30  * The class marked with {@code @Dao} should either be an interface or an abstract class. At compile
     31  * time, Room will generate an implementation of this class when it is referenced by a
     32  * {@link Database}.
     33  * <p>
     34  * An abstract {@code @Dao} class can optionally have a constructor that takes a {@link Database}
     35  * as its only parameter.
     36  * <p>
     37  * It is recommended to have multiple {@code Dao} classes in your codebase depending on the tables
     38  * they touch.
     39  *
     40  * @see Query
     41  * @see Delete
     42  * @see Insert
     43  */
     44 @Target(ElementType.TYPE)
     45 @Retention(RetentionPolicy.CLASS)
     46 public @interface Dao {
     47 }
     48