androidkotlinandroid-roomandroid-architecture-components

Reputation: 2647

Room Persistence: Error:Entities and Pojos must have a usable public constructor

I'm converting a project to Kotlin and I'm trying to make my model (which is also my entity) a data class I intend to use Moshi to convert the JSON responses from the API

@Entity(tableName = "movies")
data class MovieKt(
    @PrimaryKey
    var id : Int,
    var title: String,
    var overview: String,
    var poster_path: String,
    var backdrop_path: String,
    var release_date: String,
    var vote_average: Double,
    var isFavorite: Int
)

I can't build the app cause of the following error

Entities and Pojos must have a usable public constructor. You can have an empty constructor or a constructor whose parameters match the fields (by name and type). Cannot find setter for field.

The examples I found are not far from this

Ideas on how to solve it?

Upvotes: 114

Answers (30)

Александр Ящук

Reputation: 1

I had the same situation. I used the var synchronized field. It turned out that this name "synchronized" was reserved.

Upvotes: 0

Sandeep

Reputation: 60

I encountered the same error, and in my case it was because I had attempted to use Kotlin's unsigned types like UInt and ULong for the columns in the entity class.

So, lesson learned: Kotlin's entity types are not supported by Room, atleast as of Kotlin 1.9.10 and Room 2.6.1

Upvotes: 0

Muhammad Shoaib Murtaza

Reputation: 180

i remove @Ignore from one of my field, then it compiled without error

@Entity(tableName = "user_table")
data class User(
    @PrimaryKey(autoGenerate = true) val id: Int,
    @ColumnInfo(name = "first_name") val firstName: String,
    @ColumnInfo(name = "last_name") val lastName: String,
    val age: Int // removed @Ignore from this field
)

Upvotes: 0

Arjun Jalandhari

Reputation: 1

In my case I was using datatype name long as a field name

@Entity(tableName = "MyLocations") data class MyLocationModel( @PrimaryKey(autoGenerate = true) val id: Int = 0, var name: String, val stored: Boolean, val lat: Double, val long: Double )

just changed long to lon worked for me

@Entity(tableName = "MyLocations") data class MyLocationModel( @PrimaryKey(autoGenerate = true) val id: Int = 0, var name: String, val stored: Boolean, val lat: Double, val lon: Double )

Upvotes: 0

Ahcong Anwarbujang

Reputation: 11

I've been having this error for the longest time. And so I want to give tips to those who are facing the same problem, it may help you.

Add all these dependencies or choose the one you will be using : https://developer.android.com/jetpack/androidx/releases/lifecycle
Make sure while creating your Class (in my case Public Class Message) it implements Serializable (example)

Avoid naming your attr with capital in front, it will be hard for the DAO_impl to detect. If you want to then make sure the getter and setter is also capitalized.

Upvotes: 0

Ahcong Anwarbujang

Reputation: 11

If u use Java. Then my solution was to only ADD @Nonull in the constructor constructor(@Nonull String,

Upvotes: 0

iscariot

Reputation: 434

another problem with

@Entity
data class SomeEnity(
    @PrimaryKey(autoGenerate = true)
    val id: Long = 0,
    val filed: SomeClass
)

**inline** class SomeClass

consider to remove inline class

Upvotes: 0

Amer Biro

Reputation: 11

For this issue, I had the same problem.

Replace the Room Dependencies with that of the latest one present in the official docs

Upvotes: 1

FutureShocked

Reputation: 888

To expand on the answers provided by @evanchooly and @daneejela, you need a secondary constructor to be able to use @Ignore parameters in your primary constructor. This is so Room still has a constructor that it can use when instantiating your object. Per your example, if we ignore one of the fields:

@Entity(tableName = "movies")
data class MovieKt(
        @PrimaryKey
        var id : Int,
        var title: String,
        var overview: String,
        var poster_path: String,
        var backdrop_path: String,
        @Ignore var release_date: String,
        @Ignore var vote_average: Double,
        @Ignore var isFavorite: Int
) {
    constructor(id: Int, title: String, overview: String, poster_path: String, backdrop_path: String)
        : this(id, title, overview, poster_path, backdrop_path, "", 0.0, 0)
    
}

Upvotes: 34

jobernas

Reputation: 694

In my case I had the @Ignore Tags and 'kotlin-kapt' plugin but still this started to happen after updating to kotlin to version 1.5.0.

I ended up updating my room library from version 2.2.5 to 2.3.0 and the problem was fixed.

Upvotes: 0

Mahdi nezam parast

Reputation: 649

I had the same problem and the reason was because the type of data I was getting by query in dao , was not equal to the type of data I was returning.

The type of id in my database was String and I changed the dao from:

@Query("SELECT id FROM content_table")
fun getIds(): Flow<List<Int>>

To :

@Query("SELECT id FROM content_table")
fun getIds(): Flow<List<String>>

Upvotes: 1

seekingStillness

Reputation: 5093

I spent an hour trying to figure this out with no success. This is what I found. I forgot to add the return type in one of my Queries

this resulted with the POJO error

@Query("SELECT userNote FROM CardObject WHERE identifier = :identifier")
suspend fun getUserNote(identifier: String)

No POJO error

@Query("SELECT userNote FROM CardObject WHERE identifier = :identifier")
suspend fun getUserNote(identifier: String): String

Upvotes: 11

Asad

Reputation: 1429

make sure room database column name and field name in constructor are same

Upvotes: 0

Qazi Fahim Farhan

Reputation: 2176

Today I was having this problem. I used @Ignore, that is why I got the error. To solve this I created a secondary constructor. So my code looks something like this:

@Entity(tableName = "profile")
data class Profile(
  @field:SerializedName("id") @PrimaryKey @ColumnInfo(name = "id") var id:Long,
  @field:SerializedName("foo") @ColumnInfo(name = "foo") var foo:String?,
  @field:SerializedName("bar") @Ignore var Bar:String?
){
   constructor(id:Long, foo:String) : this(id, foo, null)
}

This worked for me.

Upvotes: 12

blackHawk

Reputation: 6307

In my case I wasn't returning type in one of the Dao query hope it helps others Thanks

Upvotes: -1

Thilaw Fabrice

Reputation: 742

I had the same issue. You can move the @Ignore fields to class body. For example :

@Entity(tableName = "movies")
data class MovieKt(
    @PrimaryKey
    var id : Int,
    var title: String
){
    //here
    @Ignore var overview: String
 }

Upvotes: 45

Ekeuwei

Reputation: 281

Kotlin plugin doesn't pick up annotationProcessor dependencies, So use the latest version of Kotlin annotation processor - put this line at top of your module's level build.gradle file

apply plugin: 'kotlin-kapt'

apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'
apply plugin: 'kotlin-kapt'  // add this line

android {
    compileSdkVersion 28
    defaultConfig {
      ........
    }
}

Don't forget to change the compileSdkVersion accordingly.

Upvotes: 1

daneejela

Reputation: 14213

It's not a problem in your case, but for others, this error can occur if you have @Ignore params in your primary constructor, i.e. Room expects to have either:

parameterless constructor or
constructor with all fields not marked with @Ignore

for example:

@Entity(tableName = "movies")
data class MovieKt(
    @PrimaryKey
    var id : Int,
    var title: String,
    @Ignore var overview: String)

will not work. This will:

@Entity(tableName = "movies")
data class MovieKt(
    @PrimaryKey
    var id : Int,
    var title: String)

Upvotes: 62

Sreekant Shenoy

Reputation: 1618

Like it's said in the Room docs, you are required to make an empty public constructor. At the same time, if you want to declare other custom constructors, you must add @Ignore annotation.

@Entity
public class CartItem {
    @PrimaryKey
    public int product_id;
    public int qty;

    public CartItem() {
    }

    @Ignore
    public CartItem(int product_id, int count) {
        this.product_id = product_id;
        this.qty = count;
    }
}

Upvotes: 2

Samuel

Reputation: 395

For a variation on FutureShocked answer that implements autoGenerate:

@Entity(tableName = "movies")
data class MovieKt(
        var title: String,
        var overview: String,
        var poster_path: String,
        var backdrop_path: String,
        @Ignore var release_date: String,
        @Ignore var vote_average: Double,
        @Ignore var isFavorite: Int
) {
@PrimaryKey(autoGenerate = true) var id : Int = 0

    constructor(title: String, overview: String, poster_path: String, backdrop_path: String) {
        this(id, title, overview, poster_path, backdrop_path, "", 0.0, 0)
    }
}

Upvotes: -2

Muhammad Maqsood

Reputation: 1652

For me, I was using 'lat' & 'long' as a variable name in the data(Entity) class for kotlin so renaming to latitude & longitude it worked.

Not working:

@Entity(tableName = "table_User")
data class User(@PrimaryKey var userId : Int, @ColumnInfo(name = "first_name") 
var firstName: String
            , @ColumnInfo(name = "last_name") var lastName: String
            , @ColumnInfo(name = "password") var password: String
            , @ColumnInfo(name = "dob") var dob: Long
            , @ColumnInfo(name = "address") var address: String
            , @ColumnInfo(name = "lat") var latitude: Double
            , @ColumnInfo(name = "long") var longitude: Double) {

}

Working:

@Entity(tableName = "table_User")
data class User(@PrimaryKey var userId : Int, @ColumnInfo(name = "first_name") 
var firstName: String
            , @ColumnInfo(name = "last_name") var lastName: String
            , @ColumnInfo(name = "password") var password: String
            , @ColumnInfo(name = "dob") var dob: Long
            , @ColumnInfo(name = "address") var address: String
            , @ColumnInfo(name = "latitude") var latitude: Double
            , @ColumnInfo(name = "longitude") var longitude: Double) {

}

Upvotes: 3

Vairavan

Reputation: 1296

With 2.1.0-alpha6, it turned out to be an invalid return type in Dao. Fixing the return type as expected fixed it.

Upvotes: 1

Enciyo

Reputation: 52

Don't use to dataclass,use normal class instead. This method will solve problem

Upvotes: -1

Rajarshi

Reputation: 2509

As stated in Room Database Entity:

Each entity must either have a no-arg constructor or a constructor whose parameters match fields (based on type and name).

So adding an empty constructor and annotating your parameterized constructor with @Ignore will solve your problem. An example:

public class POJO {

    long id;

    String firstName;

    @Ignore
    String lastName;

    public POJO() {
    }

    @Ignore
    public POJO(String firstName, String lastName) {
        this.firstName = firstName;
        this.lastName = lastName;
    }

    // getters and setters
    // ...

}

Upvotes: 0

SilenceCodder

Reputation: 3164

Just add the below annotation to any constructor that causes the errors and add a new blank constructor.

@Ignore

Upvotes: 1

Blaze Gawlik

Reputation: 347

Same bug, much stranger solution: Do not return cursor using reactivex Maybe<Cursor> on your Dao. Flowable, Single, and Observable did not work either.

Simply bite the bullet and make the reactive call outside the Dao request. Before:

@Dao
interface MyDao{
    @Query("SELECT * FROM mydao")
    fun getCursorAll(): Flowable<Cursor>
}

After:

@Dao
interface MyDao{
    @Query("SELECT * FROM mydao")
    fun getCursorAll(): Cursor
}

Meta:

Android Studio 3.2
Build #AI-181.5540.7.32.5014246, built on September 17, 2018
JRE: 1.8.0_152-release-1136-b06 x86_64
JVM: OpenJDK 64-Bit Server VM by JetBrains s.r.o
macOS 10.12.6

Upvotes: 1

Ahmed Awad

Reputation: 1815

For me all I had to do was to add a constructor to the data class with empty params sent to it like so:

    @Entity(tableName = "posts")
data class JobPost(
    @Ignore
    @SerializedName("companyLogo")
    var companyLogo: String,
    @Ignore
    @SerializedName("companyName")
    var companyName: String,
    @Ignore
    @SerializedName("isAggregated")
    var isAggregated: String,
    @PrimaryKey(autoGenerate = false)
    @SerializedName("jobID")
    var jobID: String,
    @Ignore
    @SerializedName("jobTitle")
    var jobTitle: String,
    @Ignore
    @SerializedName("postedOn")
    var postedOn: String,
    @Ignore
    @SerializedName("region")
    var region: String
) {
    constructor() : this("","","","","","","")
}

Upvotes: 11

Erik B

Reputation: 2858

Kotlin allows long as a parameter name, but this won't work when room generates java code.

Upvotes: 14

caleb grimah

Reputation: 183

I also had this issue, but i realized the problem was that i added the @Embedded annotation to a property that already had a type converter, so anyone having the same problem should check the property declarations for your model class carefully and make sure the @Embedded annotation is not on a property that has a type converter associated with it.

Upvotes: 9

kip2

Reputation: 6863

I had this problem with an entity (all fields were properly-initialized vars like a lot of the answers here are suggesting) that included a list of related, non-primitive items like the OP in this SO question had. For example:

@Entity(tableName = "fruits")
data class CachedFruitEntity(
        @PrimaryKey var id: Long = 0L,
        @Embedded(prefix = "buyer_") var buyerEntity: CachedBuyerEntity? = null
        @TypeConverters(VendorsConverter::class)
        var vendorEntities: List<CachedVendorEntity?> = listOf()))

That is, it has an embedded field, and it took me a while to realize that what I actually needed was a type converter for the vendor entity list instead (the compiler wasn't throwing the usual Error:(58, 31) error: Cannot figure out how to save this field into database. You can consider adding a type converter for it. So my solution was very similar to this answer

This google architecture components github thread has more info on this misleading error, but not sure if the issue has been fixed yet.

Upvotes: 2

Room Persistence: Error:Entities and Pojos must have a usable public constructor

Answers (30)

Related Questions