"Type of the parameter must be a class annotated with @Entity" while creating Generic DAO interface in Room

Question

I am using Room architecture component for persistence. I have created generic DAO interface to avoid boilerplate code. Room Pro Tips

But my code doesn't compile saying "Error:(21, 19) error: Type of the parameter must be a class annotated with @Entity or a collection/array of it." for the Generic class T.

interface BaseDao<T> {

@Insert(onConflict = OnConflictStrategy.REPLACE)
void insert(T... entity);

@Update
void update(T entity);

@Delete
void delete(T entity);
}

@Dao
public abstract class ReasonDao implements BaseDao<ReasonDao> {

   @Query("SELECT * from Reason")
   abstract public List<Reason> getReasons();

}

Is there anything I am missing here. It works like this here

where is your data class?

InziKhan
– InziKhan

2017-12-28 22:51:07 +00:00
Commented Dec 28, 2017 at 22:51 — InziKhan
– InziKhan, Commented Dec 28, 2017 at 22:51
did you find the solution?

Reza Bigdeli
– Reza Bigdeli

2018-03-08 18:31:13 +00:00
Commented Mar 8, 2018 at 18:31 — Reza Bigdeli
– Reza Bigdeli, Commented Mar 8, 2018 at 18:31
Yes, the accepted answer worked for me.

xrnd
– xrnd

2018-03-09 06:17:27 +00:00
Commented Mar 9, 2018 at 6:17 — xrnd
– xrnd, Commented Mar 9, 2018 at 6:17

Boken · Accepted Answer · 2022-03-03 13:56:01Z

72

Changed in gradle from this:

kapt "androidx.room:room-compiler:$roomVersion"

to this:

annotationProcessor "androidx.room:room-compiler:$room_version"

edited Mar 3, 2022 at 13:56

Boken

5,43810 gold badges41 silver badges47 bronze badges

answered Oct 15, 2021 at 18:46

Oleg Serchenko

7291 gold badge5 silver badges2 bronze badges

Sign up to request clarification or add additional context in comments.

5 Comments

EmilyJ Over a year ago

This one solved mine!

Hessam Rastegari Over a year ago

that is the solution for me, but why? I added kapt in plugins !

pjaaar Over a year ago

Changing this setting just led me to other errors. I just had to change the room version in the build.gradle (project) file as explained here: stackoverflow.com/a/73304737/1722652

m'hd semps Over a year ago

instead of doing this add the "ktx" compiler implementation "androidx.room:room-ktx:$android_room" instead and leave kapt alone

Yash Bhardwaj Over a year ago

This solve my problem and save my day. Thanks

xrnd · Accepted Answer · 2017-12-29 05:30:03Z

13

I had initially followed the method used in Kotlin, but that gives the error in Java code. Two quick changes fixed it for me

Change BaseDao to Abstract class
Added @Dao annotation to the BaseDao

Please find the code below and now it runs properly

@Dao
abstract class BaseDao<T> {

   @Insert(onConflict = OnConflictStrategy.REPLACE)
   abstract void insert(T entity);

   @Update
   abstract void update(T entity);

   @Delete
   abstract void delete(T entity);
 }

 @Dao
 public abstract class ReasonDao extends BaseDao<Reason>{

    @Query("SELECT * from Reason")
    abstract public List<Reason> getReasons();

  }

answered Dec 29, 2017 at 5:30

xrnd

1,3423 gold badges22 silver badges39 bronze badges

1 Comment

deadfish Over a year ago

Hello, according to my experience. When you get such error, try to comment all methods and sequentially uncomment each of them and rebuild every time.

Shirish Kamath · Accepted Answer · 2022-08-10 10:33:58Z

11

If you faced this issue in Kotlin 1.7.10+ and Room < 2.4.2, upgrading Room to 2.4.3 fixes the issue.

From Room's changelog for 2.4.3: Fixed an issue that would cause Room to not recognize suspend functions in Kotlin 1.7

This issue was due to using suspend functions for insert/delete in interfaces: https://issuetracker.google.com/issues/236612358

answered Aug 10, 2022 at 10:33

Shirish Kamath

3764 silver badges6 bronze badges

1 Comment

buzzcarla Over a year ago

Solved the error for me

Procrastinator · Accepted Answer · 2022-08-25 07:03:18Z

8

remove suspend,then it will work.

@Dao
interface FoodDao {

     @Insert(onConflict = OnConflictStrategy.REPLACE)
     fun upsert(meal: Meal): Long


    @Query("SELECT * FROM food_tables")
    fun getAllFood(): LiveData<List<Meal>>


    @Delete
    fun deleteFood(meal: Meal)

}

edited Aug 25, 2022 at 7:03

Procrastinator

2,67445 gold badges31 silver badges37 bronze badges

answered Aug 21, 2022 at 5:12

Swetabh Suman

1691 silver badge3 bronze badges

Comments

UneXp · Accepted Answer · 2018-12-19 20:16:02Z

6

The reason is that you specified ReasonDao type as generic parameter instead of Reason.

Original code:

@Dao
public abstract class ReasonDao implements BaseDao<ReasonDao> {

   ...

}

Correct code:

@Dao
public abstract class ReasonDao implements BaseDao<Reason> {

   ...

}

where Reason is the type marked with @Entity annotation.

By the way, this is fixed in the accepted answer, but is not mentioned in the changelist :)

answered Dec 19, 2018 at 20:16

UneXp

1,5842 gold badges16 silver badges31 bronze badges

Comments

3ameration · Accepted Answer · 2021-10-30 13:58:22Z

6

The problem was that in my build.gradle, the version of Kotlin I was using was 1.5.0

implementation "org.jetbrains.kotlin:kotlin-stdlib:1.5.0"

But as far as I understood, this version of Kotlin along with Room and coroutines doesn’t work well. Was able to resolve the issue by downgrading the Kotlin version to:

implementation "org.jetbrains.kotlin:kotlin-stdlib:1.4.32"

Solved! Thank me later

answered Oct 30, 2021 at 13:58

3ameration

2394 silver badges4 bronze badges

1 Comment

Ahmed Abdeen Over a year ago

That works for me also.

juan · Accepted Answer · 2021-12-21 18:01:57Z

Changed in gradle this: kapt "androidx.room:room-compiler:$roomVersion" to this: annotationProcessor "androidx.room:room-compiler:$room_version"

Doing this solution served me partially but when trying to insert a date in the database it did not work for me so try kapt "androidx.room:room-compiler:$roomVersion" and rather change room_version to the latest stable version https://developer.android.com/jetpack/androidx/releases/room#groovy ependencies {

//**
def room_version = '2.4.0'
def activityVersion = '1.4.0'
def lifecycle_version = "2.2.0"
// Room and Lifecycle dependencies
implementation "androidx.room:room-runtime:$room_version"
kapt "androidx.room:room-compiler:$room_version"
//kotlin extensions for coroutine support with room
implementation("androidx.room:room-ktx:$room_version")

//kotlin extension for coroutine support with activities
implementation "androidx.activity:activity-ktx:$activityVersion"
//**

This is how it worked for me correctly

Droid Chief · Accepted Answer · 2022-05-23 10:54:01Z

2

This is a version error. Try updating your room dependencies.

I changed mine from:implementation "androidx.room:room-runtime:2.2.5"

To :implementation "androidx.room:room-runtime:2.4.2"

answered May 23, 2022 at 10:54

Droid Chief

3462 silver badges2 bronze badges

Comments

CoolMind · Accepted Answer · 2018-04-23 18:11:57Z

1

In my case I tried to save to DB non-Entity objects. Then replaced with Entity class (contains @Entity(tableName = "your_table", indices = [Index("your_key")])).

answered Apr 23, 2018 at 18:11

CoolMind

29.2k18 gold badges209 silver badges247 bronze badges

Comments

nAkhmedov · Accepted Answer · 2018-05-04 09:59:03Z

1

I believe is that you have missed to give Entity annotation to T class. For example Reason class should have @Entity and give it to ReasonDao class. Like:

@Dao public abstract class ReasonDao extends BaseDao<Reason>{}

answered May 4, 2018 at 9:59

nAkhmedov

3,6025 gold badges42 silver badges75 bronze badges

Comments

Neal Ratan · Accepted Answer · 2023-04-07 18:37:29Z

1

Do not replace kapt with annotationProcessor

Try this instead

def room_version = "2.5.1"

implementation "androidx.room:room-runtime:$room_version"
annotationProcessor "androidx.room:room-compiler:$room_version"

// To use Kotlin annotation processing tool (kapt)
kapt "androidx.room:room-compiler:$room_version"

// To use Coroutine features with room
implementation "androidx.room:room-ktx:$room_version"

answered Apr 7, 2023 at 18:37

Neal Ratan

1311 silver badge4 bronze badges

Comments

androminor · Accepted Answer · 2021-05-24 04:31:27Z

0

What is missing here is the Data class. Generally, @Entity represents objects you want to store,

Room entity includes fields for each column inside the

table in the database

@Entity(tableName="something") data class YourData()

answered May 24, 2021 at 4:31

androminor

4032 silver badges14 bronze badges

Comments

Dharman · Accepted Answer · 2021-09-28 08:22:37Z

0

For those who has a "Type of the parameter must be a class annotated with @Entity or a collection/array of it " error when using Kotlin in the dao , you should try using @JvmSuppressWildcards annotation on your functions. eg.

 @Query("SELECT * FROM materials")
 @JvmSuppressWildcards
 fun getAllMaterials(): LiveData<List<MaterialModel>>

edited Sep 28, 2021 at 8:22

Dharman♦

33.9k27 gold badges106 silver badges157 bronze badges

answered Sep 28, 2021 at 8:17

Gills

11 bronze badge

Comments

oyeraghib · Accepted Answer · 2022-09-06 16:44:32Z

0

In my case I was trying to store a data class object into the Room Database. The error says that the parameter for Insert should be a class which has an annotation of @Entity so I created a table (entity) which has same values as data class and stored them successfully

answered Sep 6, 2022 at 16:44

oyeraghib

1,1023 gold badges14 silver badges40 bronze badges

Comments

Sanket Bhangale · Accepted Answer · 2022-09-09 13:24:03Z

0

One small mistake I did was I did not annotate my data class with the @Entity annotation

Table declaration

@Entity // Check if you have used this annotation or not
data class fooTable(){
...
}

In DAO

@Dao
interface myDao{
  @Insert
  suspend fun addFoo(fooObj: fooTable)
  }
}

If you are trying to insert a row in a table in Room DB then the corresponding data class should be annotated with @Entity annotation

answered Sep 9, 2022 at 13:24

Sanket Bhangale

1942 silver badges8 bronze badges

Comments

Bingba Tito · Accepted Answer · 2022-12-05 09:07:42Z

0

Actually changing the version room matters too, like I changed my room version from 2.2.6 to 2.4.3 and it worked. if the Kotlin version is low it's better to use a lower version of the room as well if the Kotlin version is high it's better to use a higher version too.

answered Dec 5, 2022 at 9:07

Bingba Tito

1

Comments

madan yadav · Accepted Answer · 2023-06-14 02:28:46Z

0

In My case dependence version issue. I have upgreade dependence now working fine. so make sure dependence is according to kotlin version.

**def room_version = "2.5.1"**
implementation "androidx.room:room-runtime:$room_version"
implementation "androidx.room:room-ktx:$room_version"
kapt "androidx.room:room-compiler:$room_version"

answered Jun 14, 2023 at 2:28

madan yadav

196 bronze badges

Comments

ahmnouira · Accepted Answer · 2023-08-05 10:39:25Z

0

I had this issue when I accidentally used vararg inside the method:

@Insert
fun insertAll(vararg postDbModels: Array<PostDbModel>)

To fix this issue I just removed vararg and using an Array of @Entity class model instead:

@Insert
fun insertAll(postDbModels: Array<PostDbModel>)

answered Aug 5, 2023 at 10:39

ahmnouira

3,8811 gold badge37 silver badges18 bronze badges

Comments

Mano Nano · Accepted Answer · 2023-10-17 20:57:00Z

0

implementation ("androidx.core:core-ktx:1.10.1")
implementation ("androidx.appcompat:appcompat:1.6.1")

implementation ("androidx.activity:activity-ktx:$activityVersion")

// Dependencies for working with Architecture components
// You'll probably have to update the version numbers in build.gradle (Project)

// Room components
implementation ("androidx.room:room-ktx:$roomVersion")
kapt ("androidx.room:room-compiler:$roomVersion")

androidTestImplementation ("androidx.room:room-testing:$roomVersion")

// Lifecycle components
implementation ("androidx.lifecycle:lifecycle-viewmodel-ktx:$lifecycleVersion")
implementation ("androidx.lifecycle:lifecycle-livedata-ktx:$lifecycleVersion")
implementation ("androidx.lifecycle:lifecycle-common-java8:$lifecycleVersion")

// Kotlin components
implementation ("org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlinVersion")
api ("org.jetbrains.kotlinx:kotlinx-coroutines-core:$coroutines")
api ("org.jetbrains.kotlinx:kotlinx-coroutines-android:$coroutines")`

answered Oct 17, 2023 at 20:57

Mano Nano

11 bronze badge

1 Comment

ΓDΛ Over a year ago

Please add a description text.

Collectives™ on Stack Overflow

"Type of the parameter must be a class annotated with @Entity" while creating Generic DAO interface in Room

19 Answers 19

5 Comments

1 Comment

1 Comment

Comments

Comments

1 Comment

Comments

Comments

Comments

Comments

Comments

Comments

Comments

Comments

Comments

Comments

Comments

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

19 Answers 19

5 Comments

1 Comment

1 Comment

Comments

Comments

1 Comment

Comments

Comments

Comments

Comments

Comments

Comments

Comments

Comments

Comments

Comments

Comments

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related