ProcessorErrors.kt revision b3c4d9308e4fd66beca3a7824a5db749ce2aace1
119b41105359a52aeb80070dec40247241231f05dYigit Boyar/* 219b41105359a52aeb80070dec40247241231f05dYigit Boyar * Copyright (C) 2016 The Android Open Source Project 319b41105359a52aeb80070dec40247241231f05dYigit Boyar * 419b41105359a52aeb80070dec40247241231f05dYigit Boyar * Licensed under the Apache License, Version 2.0 (the "License"); 519b41105359a52aeb80070dec40247241231f05dYigit Boyar * you may not use this file except in compliance with the License. 619b41105359a52aeb80070dec40247241231f05dYigit Boyar * You may obtain a copy of the License at 719b41105359a52aeb80070dec40247241231f05dYigit Boyar * 819b41105359a52aeb80070dec40247241231f05dYigit Boyar * http://www.apache.org/licenses/LICENSE-2.0 919b41105359a52aeb80070dec40247241231f05dYigit Boyar * 1019b41105359a52aeb80070dec40247241231f05dYigit Boyar * Unless required by applicable law or agreed to in writing, software 1119b41105359a52aeb80070dec40247241231f05dYigit Boyar * distributed under the License is distributed on an "AS IS" BASIS, 1219b41105359a52aeb80070dec40247241231f05dYigit Boyar * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1319b41105359a52aeb80070dec40247241231f05dYigit Boyar * See the License for the specific language governing permissions and 1419b41105359a52aeb80070dec40247241231f05dYigit Boyar * limitations under the License. 1519b41105359a52aeb80070dec40247241231f05dYigit Boyar */ 1619b41105359a52aeb80070dec40247241231f05dYigit Boyar 1764db0cc15b78b62a1d44a70fc8b4552e660d952cYigit Boyarpackage android.arch.persistence.room.processor 1864db0cc15b78b62a1d44a70fc8b4552e660d952cYigit Boyar 1964db0cc15b78b62a1d44a70fc8b4552e660d952cYigit Boyarimport android.arch.persistence.room.Delete 2064db0cc15b78b62a1d44a70fc8b4552e660d952cYigit Boyarimport android.arch.persistence.room.Insert 2164db0cc15b78b62a1d44a70fc8b4552e660d952cYigit Boyarimport android.arch.persistence.room.Query 2264db0cc15b78b62a1d44a70fc8b4552e660d952cYigit Boyarimport android.arch.persistence.room.Update 2364db0cc15b78b62a1d44a70fc8b4552e660d952cYigit Boyarimport android.arch.persistence.room.ext.RoomTypeNames 2464db0cc15b78b62a1d44a70fc8b4552e660d952cYigit Boyarimport android.arch.persistence.room.parser.SQLTypeAffinity 2564db0cc15b78b62a1d44a70fc8b4552e660d952cYigit Boyarimport android.arch.persistence.room.vo.CustomTypeConverter 2664db0cc15b78b62a1d44a70fc8b4552e660d952cYigit Boyarimport android.arch.persistence.room.vo.Field 2788865f77c35657a2bc545a718ca16a648fc8b62eYigit Boyarimport com.squareup.javapoet.TypeName 28875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyarimport javax.lang.model.type.TypeMirror 2919b41105359a52aeb80070dec40247241231f05dYigit Boyar 3019b41105359a52aeb80070dec40247241231f05dYigit Boyarobject ProcessorErrors { 312c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar private fun String.trim(): String { 32b78956d6a56230a8c2f86b6e749d35e880e4d6efshepshapard return this.trimIndent().replace("\n", " ") 332c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar } 3419b41105359a52aeb80070dec40247241231f05dYigit Boyar val MISSING_QUERY_ANNOTATION = "Query methods must be annotated with ${Query::class.java}" 354f0db7db556b473393dfc31bba5ea67def574877Yigit Boyar val MISSING_INSERT_ANNOTATION = "Insertion methods must be annotated with ${Insert::class.java}" 36958df7dd95c2cecf93cacef6998a4d7e8d39b7efYigit Boyar val MISSING_DELETE_ANNOTATION = "Deletion methods must be annotated with ${Delete::class.java}" 3774b28faea4bcc4b7fab113a61a066d22dfae7258Yigit Boyar val MISSING_UPDATE_ANNOTATION = "Update methods must be annotated with ${Update::class.java}" 38333b4b5e49c48adf7fb928d445b6f7f276b54a02Yigit Boyar val INVALID_ON_CONFLICT_VALUE = "On conflict value must be one of @OnConflictStrategy values." 394f0db7db556b473393dfc31bba5ea67def574877Yigit Boyar val INVALID_INSERTION_METHOD_RETURN_TYPE = "Methods annotated with @Insert can return either" + 40dd6aaec8254abfee2dd82a5f2c59282f8eeee9eeYuichi Araki " void, long, Long, long[], Long[] or List<Long>." 41f5f2cf6b9ed63915448e81551e4b7bb72a26030eYigit Boyar 42f5f2cf6b9ed63915448e81551e4b7bb72a26030eYigit Boyar fun insertionMethodReturnTypeMismatch(definedReturn : TypeName, 43f5f2cf6b9ed63915448e81551e4b7bb72a26030eYigit Boyar expectedReturnTypes : List<TypeName>) : String { 44f5f2cf6b9ed63915448e81551e4b7bb72a26030eYigit Boyar return "Method returns $definedReturn but it should return one of the following: `" + 45f5f2cf6b9ed63915448e81551e4b7bb72a26030eYigit Boyar expectedReturnTypes.joinToString(", ") + "`. If you want to return the list of" + 46f5f2cf6b9ed63915448e81551e4b7bb72a26030eYigit Boyar " row ids from the query, your insertion method can receive only 1 parameter." 47f5f2cf6b9ed63915448e81551e4b7bb72a26030eYigit Boyar } 48f5f2cf6b9ed63915448e81551e4b7bb72a26030eYigit Boyar 494f0db7db556b473393dfc31bba5ea67def574877Yigit Boyar val ABSTRACT_METHOD_IN_DAO_MISSING_ANY_ANNOTATION = "Abstract method in DAO must be annotated" + 504f0db7db556b473393dfc31bba5ea67def574877Yigit Boyar " with ${Query::class.java} AND ${Insert::class.java}" 51958df7dd95c2cecf93cacef6998a4d7e8d39b7efYigit Boyar val CANNOT_USE_MORE_THAN_ONE_DAO_METHOD_ANNOTATION = "A DAO method can be annotated with only" + 52958df7dd95c2cecf93cacef6998a4d7e8d39b7efYigit Boyar " one of the following:" + DaoProcessor.PROCESSED_ANNOTATIONS.joinToString(",") { 53958df7dd95c2cecf93cacef6998a4d7e8d39b7efYigit Boyar it.java.simpleName 54958df7dd95c2cecf93cacef6998a4d7e8d39b7efYigit Boyar } 5519b41105359a52aeb80070dec40247241231f05dYigit Boyar val CANNOT_RESOLVE_RETURN_TYPE = "Cannot resolve return type for %s" 564f0db7db556b473393dfc31bba5ea67def574877Yigit Boyar val CANNOT_USE_UNBOUND_GENERICS_IN_QUERY_METHODS = "Cannot use unbound generics in query" + 574f0db7db556b473393dfc31bba5ea67def574877Yigit Boyar " methods. It must be bound to a type through base Dao class." 584f0db7db556b473393dfc31bba5ea67def574877Yigit Boyar val CANNOT_USE_UNBOUND_GENERICS_IN_INSERTION_METHODS = "Cannot use unbound generics in" + 594f0db7db556b473393dfc31bba5ea67def574877Yigit Boyar " insertion methods. It must be bound to a type through base Dao class." 60de33ce4068e2678c03fa6fd62f4770be89f79adcYigit Boyar val CANNOT_USE_UNBOUND_GENERICS_IN_ENTITY_FIELDS = "Cannot use unbound fields in entities." 610f77cff2005ccc6263b9902b3ea56fe01161ba51Yigit Boyar val CANNOT_USE_UNBOUND_GENERICS_IN_DAO_CLASSES = "Cannot use unbound generics in Dao classes." + 620f77cff2005ccc6263b9902b3ea56fe01161ba51Yigit Boyar " If you are trying to create a base DAO, create a normal class, extend it with type" + 630f77cff2005ccc6263b9902b3ea56fe01161ba51Yigit Boyar " params then mark the subclass with @Dao." 641600cc11df868b62b6ae3995d94a3ec0b86559adYigit Boyar val CANNOT_FIND_GETTER_FOR_FIELD = "Cannot find getter for field." 651600cc11df868b62b6ae3995d94a3ec0b86559adYigit Boyar val CANNOT_FIND_SETTER_FOR_FIELD = "Cannot find setter for field." 66e6325fbeaa2e6759496ea2ca9a4d3d958df690d7Yigit Boyar val MISSING_PRIMARY_KEY = "An entity must have at least 1 field annotated with @PrimaryKey" 672c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar val AUTO_INCREMENTED_PRIMARY_KEY_IS_NOT_INT = "If a primary key is annotated with" + 682c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar " autoGenerate, its type must be int, Integer, long or Long." 694d4bae3f216e55f824d7d7fbfe2f8861906ee3e2Yigit Boyar val AUTO_INCREMENT_EMBEDDED_HAS_MULTIPLE_FIELDS = "When @PrimaryKey annotation is used on a" + 704d4bae3f216e55f824d7d7fbfe2f8861906ee3e2Yigit Boyar " field annotated with @Embedded, the embedded class should have only 1 field." 712c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar 722c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar fun multiplePrimaryKeyAnnotations(primaryKeys: List<String>): String { 732c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar return """ 742c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar You cannot have multiple primary keys defined in an Entity. If you 752c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar want to declare a composite primary key, you should use @Entity#primaryKeys and 762c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar not use @PrimaryKey. Defined Primary Keys: 772c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar ${primaryKeys.joinToString(", ")}""".trim() 782c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar } 792c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar 802c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar fun primaryKeyColumnDoesNotExist(columnName: String, allColumns: List<String>): String { 812c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar return "$columnName referenced in the primary key does not exists in the Entity." + 822c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar " Available column names:${allColumns.joinToString(", ")}" 832c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar } 842c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar 850f77cff2005ccc6263b9902b3ea56fe01161ba51Yigit Boyar val DAO_MUST_BE_AN_ABSTRACT_CLASS_OR_AN_INTERFACE = "Dao class must be an abstract class or" + 860f77cff2005ccc6263b9902b3ea56fe01161ba51Yigit Boyar " an interface" 878bad027c789d3fb3da8e68fa0154f2a24ccc2865Yigit Boyar val DATABASE_MUST_BE_ANNOTATED_WITH_DATABASE = "Database must be annotated with @Database" 888bad027c789d3fb3da8e68fa0154f2a24ccc2865Yigit Boyar val DAO_MUST_BE_ANNOTATED_WITH_DAO = "Dao class must be annotated with @Dao" 8917caba59e1fd850fe1381d7311d23afc4e07cdfbYuichi Araki 9017caba59e1fd850fe1381d7311d23afc4e07cdfbYuichi Araki fun daoMustHaveMatchingConstructor(daoName: String, dbName: String): String { 9117caba59e1fd850fe1381d7311d23afc4e07cdfbYuichi Araki return """ 9217caba59e1fd850fe1381d7311d23afc4e07cdfbYuichi Araki $daoName needs to have either an empty constructor or a constructor that takes 9317caba59e1fd850fe1381d7311d23afc4e07cdfbYuichi Araki $dbName as its only parameter. 9417caba59e1fd850fe1381d7311d23afc4e07cdfbYuichi Araki """.trim() 9517caba59e1fd850fe1381d7311d23afc4e07cdfbYuichi Araki } 9617caba59e1fd850fe1381d7311d23afc4e07cdfbYuichi Araki 978bad027c789d3fb3da8e68fa0154f2a24ccc2865Yigit Boyar val ENTITY_MUST_BE_ANNOTATED_WITH_ENTITY = "Entity class must be annotated with @Entity" 988bad027c789d3fb3da8e68fa0154f2a24ccc2865Yigit Boyar val DATABASE_ANNOTATION_MUST_HAVE_LIST_OF_ENTITIES = "@Database annotation must specify list" + 998bad027c789d3fb3da8e68fa0154f2a24ccc2865Yigit Boyar " of entities" 1000fc66ddc60bdc71d5466bb1db1a218e5a3d9c1fcYigit Boyar val COLUMN_NAME_CANNOT_BE_EMPTY = "Column name cannot be blank. If you don't want to set it" + 101275e7088223c097c1a2df718455bede42bc9efedYigit Boyar ", just remove the @ColumnInfo annotation or use @ColumnInfo.INHERIT_FIELD_NAME." 1020fc66ddc60bdc71d5466bb1db1a218e5a3d9c1fcYigit Boyar 1030fc66ddc60bdc71d5466bb1db1a218e5a3d9c1fcYigit Boyar val ENTITY_TABLE_NAME_CANNOT_BE_EMPTY = "Entity table name cannot be blank. If you don't want" + 1040fc66ddc60bdc71d5466bb1db1a218e5a3d9c1fcYigit Boyar " to set it, just remove the tableName property." 1050f77cff2005ccc6263b9902b3ea56fe01161ba51Yigit Boyar 106275e7088223c097c1a2df718455bede42bc9efedYigit Boyar val CANNOT_BIND_QUERY_PARAMETER_INTO_STMT = "Query method parameters should either be a" + 107275e7088223c097c1a2df718455bede42bc9efedYigit Boyar " type that can be converted into a database column or a List / Array that contains" + 108275e7088223c097c1a2df718455bede42bc9efedYigit Boyar " such type. You can consider adding a Type Adapter for this." 109250a3e6dc5d50c533575b7d276730b89eecc7c19Yigit Boyar 1104f0db7db556b473393dfc31bba5ea67def574877Yigit Boyar val QUERY_PARAMETERS_CANNOT_START_WITH_UNDERSCORE = "Query/Insert method parameters cannot " + 1114f0db7db556b473393dfc31bba5ea67def574877Yigit Boyar "start with underscore (_)." 1128e543c445cb5559e579f54c1ac00d0ca83ec3fbbYigit Boyar 113efaf86afac3163868eda7f91a1c04e3f6e6d7520Yigit Boyar val CANNOT_FIND_QUERY_RESULT_ADAPTER = "Not sure how to convert a Cursor to this method's " + 114efaf86afac3163868eda7f91a1c04e3f6e6d7520Yigit Boyar "return type" 115efaf86afac3163868eda7f91a1c04e3f6e6d7520Yigit Boyar 1164f0db7db556b473393dfc31bba5ea67def574877Yigit Boyar val INSERTION_DOES_NOT_HAVE_ANY_PARAMETERS_TO_INSERT = "Method annotated with" + 1174f0db7db556b473393dfc31bba5ea67def574877Yigit Boyar " @Insert but does not have any parameters to insert." 1184f0db7db556b473393dfc31bba5ea67def574877Yigit Boyar 11974b28faea4bcc4b7fab113a61a066d22dfae7258Yigit Boyar val DELETION_MISSING_PARAMS = "Method annotated with" + 120958df7dd95c2cecf93cacef6998a4d7e8d39b7efYigit Boyar " @Delete but does not have any parameters to delete." 121958df7dd95c2cecf93cacef6998a4d7e8d39b7efYigit Boyar 12274b28faea4bcc4b7fab113a61a066d22dfae7258Yigit Boyar val UPDATE_MISSING_PARAMS = "Method annotated with" + 12374b28faea4bcc4b7fab113a61a066d22dfae7258Yigit Boyar " @Update but does not have any parameters to update." 12474b28faea4bcc4b7fab113a61a066d22dfae7258Yigit Boyar 125b3c4d9308e4fd66beca3a7824a5db749ce2aace1Yuichi Araki val TRANSACTION_METHOD_MODIFIERS = "Method annotated with @Transaction must not be " + 126b3c4d9308e4fd66beca3a7824a5db749ce2aace1Yuichi Araki "private, final, or abstract." 127b3c4d9308e4fd66beca3a7824a5db749ce2aace1Yuichi Araki 128958df7dd95c2cecf93cacef6998a4d7e8d39b7efYigit Boyar val CANNOT_FIND_ENTITY_FOR_SHORTCUT_QUERY_PARAMETER = "Type of the parameter must be a class " + 129958df7dd95c2cecf93cacef6998a4d7e8d39b7efYigit Boyar "annotated with @Entity or a collection/array of it." 1304f0db7db556b473393dfc31bba5ea67def574877Yigit Boyar 131291985054e698c918df1c735d1042b63b9e97219Yigit Boyar val DB_MUST_EXTEND_ROOM_DB = "Classes annotated with @Database should extend " + 132291985054e698c918df1c735d1042b63b9e97219Yigit Boyar RoomTypeNames.ROOM_DB 133291985054e698c918df1c735d1042b63b9e97219Yigit Boyar 134846dfcf52e22de6d912f8ece05ff939c2c9bd154Yigit Boyar val LIVE_DATA_QUERY_WITHOUT_SELECT = "LiveData return type can only be used with SELECT" + 135846dfcf52e22de6d912f8ece05ff939c2c9bd154Yigit Boyar " queries." 136846dfcf52e22de6d912f8ece05ff939c2c9bd154Yigit Boyar 1372c56b466fc39da8bc5cb82dc494e534768e65eabshepshapard val LIVE_DATA_QUERY_NOTHING_TO_OBSERVE = "LiveData return type can only be used with SELECT" + 1382c56b466fc39da8bc5cb82dc494e534768e65eabshepshapard " queries that directly or indirectly (via @Relation, for example) access at least" + 1392c56b466fc39da8bc5cb82dc494e534768e65eabshepshapard " one table."; 1402c56b466fc39da8bc5cb82dc494e534768e65eabshepshapard 141250a3e6dc5d50c533575b7d276730b89eecc7c19Yigit Boyar private val TOO_MANY_MATCHING_GETTERS = "Ambiguous getter for %s. All of the following " + 142250a3e6dc5d50c533575b7d276730b89eecc7c19Yigit Boyar "match: %s. You can @Ignore the ones that you don't want to match." 143efaf86afac3163868eda7f91a1c04e3f6e6d7520Yigit Boyar 144efaf86afac3163868eda7f91a1c04e3f6e6d7520Yigit Boyar fun tooManyMatchingGetters(field: Field, methodNames: List<String>): String { 1451600cc11df868b62b6ae3995d94a3ec0b86559adYigit Boyar return TOO_MANY_MATCHING_GETTERS.format(field, methodNames.joinToString(", ")) 1461600cc11df868b62b6ae3995d94a3ec0b86559adYigit Boyar } 1471600cc11df868b62b6ae3995d94a3ec0b86559adYigit Boyar 148250a3e6dc5d50c533575b7d276730b89eecc7c19Yigit Boyar private val TOO_MANY_MATCHING_SETTERS = "Ambiguous setter for %s. All of the following " + 149250a3e6dc5d50c533575b7d276730b89eecc7c19Yigit Boyar "match: %s. You can @Ignore the ones that you don't want to match." 150efaf86afac3163868eda7f91a1c04e3f6e6d7520Yigit Boyar 151efaf86afac3163868eda7f91a1c04e3f6e6d7520Yigit Boyar fun tooManyMatchingSetter(field: Field, methodNames: List<String>): String { 1521600cc11df868b62b6ae3995d94a3ec0b86559adYigit Boyar return TOO_MANY_MATCHING_SETTERS.format(field, methodNames.joinToString(", ")) 1531600cc11df868b62b6ae3995d94a3ec0b86559adYigit Boyar } 154250a3e6dc5d50c533575b7d276730b89eecc7c19Yigit Boyar 155275e7088223c097c1a2df718455bede42bc9efedYigit Boyar val CANNOT_FIND_COLUMN_TYPE_ADAPTER = "Cannot figure out how to save this field into" + 156275e7088223c097c1a2df718455bede42bc9efedYigit Boyar " database. You can consider adding a type converter for it." 157275e7088223c097c1a2df718455bede42bc9efedYigit Boyar 158275e7088223c097c1a2df718455bede42bc9efedYigit Boyar val CANNOT_FIND_STMT_BINDER = "Cannot figure out how to bind this field into a statement." 159275e7088223c097c1a2df718455bede42bc9efedYigit Boyar 160275e7088223c097c1a2df718455bede42bc9efedYigit Boyar val CANNOT_FIND_CURSOR_READER = "Cannot figure out how to read this field from a cursor." 161275e7088223c097c1a2df718455bede42bc9efedYigit Boyar 162250a3e6dc5d50c533575b7d276730b89eecc7c19Yigit Boyar private val MISSING_PARAMETER_FOR_BIND = "Each bind variable in the query must have a" + 163250a3e6dc5d50c533575b7d276730b89eecc7c19Yigit Boyar " matching method parameter. Cannot find method parameters for %s." 164efaf86afac3163868eda7f91a1c04e3f6e6d7520Yigit Boyar 165250a3e6dc5d50c533575b7d276730b89eecc7c19Yigit Boyar fun missingParameterForBindVariable(bindVarName: List<String>): String { 166250a3e6dc5d50c533575b7d276730b89eecc7c19Yigit Boyar return MISSING_PARAMETER_FOR_BIND.format(bindVarName.joinToString(", ")) 167250a3e6dc5d50c533575b7d276730b89eecc7c19Yigit Boyar } 168250a3e6dc5d50c533575b7d276730b89eecc7c19Yigit Boyar 169250a3e6dc5d50c533575b7d276730b89eecc7c19Yigit Boyar private val UNUSED_QUERY_METHOD_PARAMETER = "Unused parameter%s: %s" 170250a3e6dc5d50c533575b7d276730b89eecc7c19Yigit Boyar fun unusedQueryMethodParameter(unusedParams: List<String>): String { 171250a3e6dc5d50c533575b7d276730b89eecc7c19Yigit Boyar return UNUSED_QUERY_METHOD_PARAMETER.format( 172250a3e6dc5d50c533575b7d276730b89eecc7c19Yigit Boyar if (unusedParams.size > 1) "s" else "", 173250a3e6dc5d50c533575b7d276730b89eecc7c19Yigit Boyar unusedParams.joinToString(",")) 174250a3e6dc5d50c533575b7d276730b89eecc7c19Yigit Boyar } 175af2292b2f53204a3004f53201f51908d70d8090eYigit Boyar 176af2292b2f53204a3004f53201f51908d70d8090eYigit Boyar private val DUPLICATE_TABLES = "Table name \"%s\" is used by multiple entities: %s" 17713a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar fun duplicateTableNames(tableName: String, entityNames: List<String>): String { 178af2292b2f53204a3004f53201f51908d70d8090eYigit Boyar return DUPLICATE_TABLES.format(tableName, entityNames.joinToString(", ")) 179af2292b2f53204a3004f53201f51908d70d8090eYigit Boyar } 180958df7dd95c2cecf93cacef6998a4d7e8d39b7efYigit Boyar 181958df7dd95c2cecf93cacef6998a4d7e8d39b7efYigit Boyar val DELETION_METHODS_MUST_RETURN_VOID_OR_INT = "Deletion methods must either return void or" + 182958df7dd95c2cecf93cacef6998a4d7e8d39b7efYigit Boyar " return int (the number of deleted rows)." 18388865f77c35657a2bc545a718ca16a648fc8b62eYigit Boyar 18474b28faea4bcc4b7fab113a61a066d22dfae7258Yigit Boyar val UPDATE_METHODS_MUST_RETURN_VOID_OR_INT = "Update methods must either return void or" + 18574b28faea4bcc4b7fab113a61a066d22dfae7258Yigit Boyar " return int (the number of updated rows)." 18674b28faea4bcc4b7fab113a61a066d22dfae7258Yigit Boyar 18788865f77c35657a2bc545a718ca16a648fc8b62eYigit Boyar val DAO_METHOD_CONFLICTS_WITH_OTHERS = "Dao method has conflicts." 18888865f77c35657a2bc545a718ca16a648fc8b62eYigit Boyar 18913a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar fun duplicateDao(dao: TypeName, methodNames: List<String>): String { 19088865f77c35657a2bc545a718ca16a648fc8b62eYigit Boyar return """ 191275e7088223c097c1a2df718455bede42bc9efedYigit Boyar All of these functions [${methodNames.joinToString(", ")}] return the same DAO 192275e7088223c097c1a2df718455bede42bc9efedYigit Boyar class [$dao]. 19313a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar A database can use a DAO only once so you should remove ${methodNames.size - 1} of 19413a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar these conflicting DAO methods. If you are implementing any of these to fulfill an 19513a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar interface, don't make it abstract, instead, implement the code that calls the 19613a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar other one. 1972c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar """.trim() 19813a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar } 19913a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar 20013a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar fun cursorPojoMismatch(pojoTypeName: TypeName, 20113a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar unusedColumns: List<String>, allColumns: List<String>, 20213a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar unusedFields: List<Field>, allFields: List<Field>): String { 2032c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar val unusedColumnsWarning = if (unusedColumns.isNotEmpty()) { 2042c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar """ 205275e7088223c097c1a2df718455bede42bc9efedYigit Boyar The query returns some columns [${unusedColumns.joinToString(", ")}] which are not 206275e7088223c097c1a2df718455bede42bc9efedYigit Boyar use by $pojoTypeName. You can use @ColumnInfo annotation on the fields to specify 20713a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar the mapping. 2082c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar """.trim() 20913a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar } else { 21013a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar "" 21113a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar } 2122c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar val unusedFieldsWarning = if (unusedFields.isNotEmpty()) { 2132c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar """ 21413a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar $pojoTypeName has some fields 215275e7088223c097c1a2df718455bede42bc9efedYigit Boyar [${unusedFields.joinToString(", ") { it.columnName }}] which are not returned by the 21613a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar query. If they are not supposed to be read from the result, you can mark them with 21713a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar @Ignore annotation. 2182c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar """.trim() 21913a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar } else { 22013a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar "" 22113a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar } 22213a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar return """ 22313a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar $unusedColumnsWarning 22413a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar $unusedFieldsWarning 22513a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar You can suppress this warning by annotating the method with 22613a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar @SuppressWarnings(RoomWarnings.CURSOR_MISMATCH). 22713a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar Columns returned by the query: ${allColumns.joinToString(", ")}. 22813a2048db98b1cc2dbd1692b73b794527975a446Yigit Boyar Fields in $pojoTypeName: ${allFields.joinToString(", ") { it.columnName }}. 2292c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar """.trim() 23088865f77c35657a2bc545a718ca16a648fc8b62eYigit Boyar } 23188865f77c35657a2bc545a718ca16a648fc8b62eYigit Boyar 232275e7088223c097c1a2df718455bede42bc9efedYigit Boyar val TYPE_CONVERTER_UNBOUND_GENERIC = "Cannot use unbound generics in Type Converters." 233275e7088223c097c1a2df718455bede42bc9efedYigit Boyar val TYPE_CONVERTER_BAD_RETURN_TYPE = "Invalid return type for a type converter." 234275e7088223c097c1a2df718455bede42bc9efedYigit Boyar val TYPE_CONVERTER_MUST_RECEIVE_1_PARAM = "Type converters must receive 1 parameter." 235275e7088223c097c1a2df718455bede42bc9efedYigit Boyar val TYPE_CONVERTER_EMPTY_CLASS = "Class is referenced as a converter but it does not have any" + 236275e7088223c097c1a2df718455bede42bc9efedYigit Boyar " converter methods." 237275e7088223c097c1a2df718455bede42bc9efedYigit Boyar val TYPE_CONVERTER_MISSING_NOARG_CONSTRUCTOR = "Classes that are used as TypeConverters must" + 238275e7088223c097c1a2df718455bede42bc9efedYigit Boyar " have no-argument public constructors." 239275e7088223c097c1a2df718455bede42bc9efedYigit Boyar val TYPE_CONVERTER_MUST_BE_PUBLIC = "Type converters must be public." 240275e7088223c097c1a2df718455bede42bc9efedYigit Boyar 2412c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar fun duplicateTypeConverters(converters: List<CustomTypeConverter>): String { 242275e7088223c097c1a2df718455bede42bc9efedYigit Boyar return "Multiple methods define the same conversion. Conflicts with these:" + 243275e7088223c097c1a2df718455bede42bc9efedYigit Boyar " ${converters.joinToString(", ") { it.toString() }}" 244275e7088223c097c1a2df718455bede42bc9efedYigit Boyar } 24596cc740203eaa752fc85ca7ca722a8de550ae88cYigit Boyar 24696cc740203eaa752fc85ca7ca722a8de550ae88cYigit Boyar // TODO must print field paths. 24796cc740203eaa752fc85ca7ca722a8de550ae88cYigit Boyar val POJO_FIELD_HAS_DUPLICATE_COLUMN_NAME = "Field has non-unique column name." 24896cc740203eaa752fc85ca7ca722a8de550ae88cYigit Boyar 2492c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar fun pojoDuplicateFieldNames(columnName: String, fieldPaths: List<String>): String { 25096cc740203eaa752fc85ca7ca722a8de550ae88cYigit Boyar return "Multiple fields have the same columnName: $columnName." + 25196cc740203eaa752fc85ca7ca722a8de550ae88cYigit Boyar " Field names: ${fieldPaths.joinToString(", ")}." 25296cc740203eaa752fc85ca7ca722a8de550ae88cYigit Boyar } 25396cc740203eaa752fc85ca7ca722a8de550ae88cYigit Boyar 2544d4bae3f216e55f824d7d7fbfe2f8861906ee3e2Yigit Boyar fun embeddedPrimaryKeyIsDropped(entityQName: String, fieldName: String): String { 25596cc740203eaa752fc85ca7ca722a8de550ae88cYigit Boyar return "Primary key constraint on $fieldName is ignored when being merged into " + 25696cc740203eaa752fc85ca7ca722a8de550ae88cYigit Boyar entityQName 25796cc740203eaa752fc85ca7ca722a8de550ae88cYigit Boyar } 258dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar 259dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar val INDEX_COLUMNS_CANNOT_BE_EMPTY = "List of columns in an index cannot be empty" 260dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar 2612c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar fun indexColumnDoesNotExist(columnName: String, allColumns: List<String>): String { 262dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar return "$columnName referenced in the index does not exists in the Entity." + 263dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar " Available column names:${allColumns.joinToString(", ")}" 264dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar } 265dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar 2662c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar fun duplicateIndexInEntity(indexName: String): String { 267dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar return "There are multiple indices with name $indexName. This happen if you've declared" + 268dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar " the same index multiple times or different indices have the same name. See" + 269dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar " @Index documentation for details." 270dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar } 271dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar 2722c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar fun duplicateIndexInDatabase(indexName: String, indexPaths: List<String>): String { 273dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar return "There are multiple indices with name $indexName. You should rename " + 274dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar "${indexPaths.size - 1} of these to avoid the conflict:" + 275dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar "${indexPaths.joinToString(", ")}." 276dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar } 277dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar 2784d4bae3f216e55f824d7d7fbfe2f8861906ee3e2Yigit Boyar fun droppedEmbeddedFieldIndex(fieldPath: String, grandParent: String): String { 279dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar return "The index will be dropped when being merged into $grandParent" + 280dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar "($fieldPath). You must re-declare it in $grandParent if you want to index this" + 281dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar " field in $grandParent." 282dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar } 283dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar 2844d4bae3f216e55f824d7d7fbfe2f8861906ee3e2Yigit Boyar fun droppedEmbeddedIndex(entityName: String, fieldPath: String, grandParent: String) 285dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar : String { 286dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar return "Indices defined in $entityName will be dropped when it is merged into" + 287dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar " $grandParent ($fieldPath). You can re-declare them in $grandParent." 288dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar } 289dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar 2902c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar fun droppedSuperClassIndex(childEntity: String, superEntity: String): String { 291dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar return "Indices defined in $superEntity will NOT be re-used in $childEntity. If you want" + 292dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar " to inherit them, you must re-declare them in $childEntity." + 293dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar " Alternatively, you can set inheritSuperIndices to true in the @Entity annotation." 294dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar } 295dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar 2962c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar fun droppedSuperClassFieldIndex(fieldName: String, childEntity: String, 2972c6462f129bf43965ed8b054b026f6a28fe6fd8fYigit Boyar superEntity: String): String { 298dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar return "Index defined on field `$fieldName` in $superEntity will NOT be re-used in" + 299dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar " $childEntity. " + 300dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar "If you want to inherit it, you must re-declare it in $childEntity." + 301dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar " Alternatively, you can set inheritSuperIndices to true in the @Entity annotation." 302dc18ce63fe07921b1080e48d3e597e2b5240d17aYigit Boyar } 303092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar 304092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar val RELATION_NOT_COLLECTION = "Fields annotated with @Relation must be a List or Set." 305092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar 306f385ca501bbfd3ccaf6b412f8f09c64d9ee742f2Yigit Boyar fun relationCannotFindEntityField(entityName : String, columnName: String, 307f385ca501bbfd3ccaf6b412f8f09c64d9ee742f2Yigit Boyar availableColumns: List<String>) : String { 308f385ca501bbfd3ccaf6b412f8f09c64d9ee742f2Yigit Boyar return "Cannot find the child entity column `$columnName` in $entityName." + 309f385ca501bbfd3ccaf6b412f8f09c64d9ee742f2Yigit Boyar " Options: ${availableColumns.joinToString(", ")}" 310092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar } 311092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar 312f385ca501bbfd3ccaf6b412f8f09c64d9ee742f2Yigit Boyar fun relationCannotFindParentEntityField(entityName : String, columnName: String, 313f385ca501bbfd3ccaf6b412f8f09c64d9ee742f2Yigit Boyar availableColumns: List<String>) : String { 314f385ca501bbfd3ccaf6b412f8f09c64d9ee742f2Yigit Boyar return "Cannot find the parent entity column `$columnName` in $entityName." + 315f385ca501bbfd3ccaf6b412f8f09c64d9ee742f2Yigit Boyar " Options: ${availableColumns.joinToString(", ")}" 316092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar } 317092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar 318092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar val RELATION_IN_ENTITY = "Entities cannot have relations." 319092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar 320092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar val CANNOT_FIND_TYPE = "Cannot find type." 321092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar 322f385ca501bbfd3ccaf6b412f8f09c64d9ee742f2Yigit Boyar fun relationAffinityMismatch(parentColumn: String, childColumn: String, 323092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar parentAffinity : SQLTypeAffinity?, 324092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar childAffinity : SQLTypeAffinity?) : String { 325092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar return """ 326f385ca501bbfd3ccaf6b412f8f09c64d9ee742f2Yigit Boyar The affinity of parent column ($parentColumn : $parentAffinity) does not match the type 327f385ca501bbfd3ccaf6b412f8f09c64d9ee742f2Yigit Boyar affinity of the child column ($childColumn : $childAffinity). 328092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar """.trim() 329092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar } 330092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar 331092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar val CANNOT_USE_MORE_THAN_ONE_POJO_FIELD_ANNOTATION = "A field can be annotated with only" + 332092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar " one of the following:" + PojoProcessor.PROCESSED_ANNOTATIONS.joinToString(",") { 333092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar it.java.simpleName 334092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar } 335092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar 336092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar fun relationBadProject(entityQName : String, missingColumnNames : List<String>, 337092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar availableColumnNames : List<String>) : String { 338092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar return """ 339092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar $entityQName does not have the following columns: ${missingColumnNames.joinToString(",")}. 340092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar Available columns are: ${availableColumnNames.joinToString(",")} 341092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar """.trim() 342092164e5501d0a254001225acd9dca42e5fa57e9Yigit Boyar } 343a64756a18111a7312b3fa03b76d13381a8907176Yigit Boyar 344a64756a18111a7312b3fa03b76d13381a8907176Yigit Boyar val MISSING_SCHEMA_EXPORT_DIRECTORY = "Schema export directory is not provided to the" + 345a64756a18111a7312b3fa03b76d13381a8907176Yigit Boyar " annotation processor so we cannot export the schema. You can either provide" + 346a64756a18111a7312b3fa03b76d13381a8907176Yigit Boyar " `room.schemaLocation` annotation processor argument OR set exportSchema to false." 347875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar 348875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar val INVALID_FOREIGN_KEY_ACTION = "Invalid foreign key action. It must be one of the constants" + 349875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar " defined in ForeignKey.Action" 350875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar 351875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar fun foreignKeyNotAnEntity(className : String) : String { 352875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar return """ 353875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar Classes referenced in Foreign Key annotations must be @Entity classes. $className is not 354875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar an entity 355875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar """.trim() 356875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar } 357875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar 358875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar val FOREIGN_KEY_CANNOT_FIND_PARENT = "Cannot find parent entity class." 359875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar 360875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar fun foreignKeyChildColumnDoesNotExist(columnName: String, allColumns: List<String>): String { 361875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar return "($columnName) referenced in the foreign key does not exists in the Entity." + 362875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar " Available column names:${allColumns.joinToString(", ")}" 363875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar } 364875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar 365875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar fun foreignKeyParentColumnDoesNotExist(parentEntity : String, 366875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar missingColumn: String, 367875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar allColumns : List<String>): String { 368875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar return "($missingColumn) does not exist in $parentEntity. Available columns are" + 369875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar " ${allColumns.joinToString(",")}" 370875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar } 371875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar 372875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar val FOREIGN_KEY_EMPTY_CHILD_COLUMN_LIST = "Must specify at least 1 column name for the child" 373875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar 374875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar val FOREIGN_KEY_EMPTY_PARENT_COLUMN_LIST = "Must specify at least 1 column name for the parent" 375875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar 376875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar fun foreignKeyColumnNumberMismatch(childColumns : List<String>, parentColumns : List<String>) 377875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar : String { 378875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar return """ 379875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar Number of child columns in foreign key must match number of parent columns. 380875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar Child reference has ${childColumns.joinToString(",")} and parent reference has 381875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar ${parentColumns.joinToString(",")} 382875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar """.trim() 383875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar } 384875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar 385875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar fun foreignKeyMissingParentEntityInDatabase(parentTable : String, childEntity : String) 386875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar : String { 387875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar return """ 388875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar $parentTable table referenced in the foreign keys of $childEntity does not exist in 389875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar the database. Maybe you forgot to add the referenced entity in the entities list of 390875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar the @Database annotation?""".trim() 391875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar } 392875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar 393875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar fun foreignKeyMissingIndexInParent(parentEntity : String, parentColumns: List<String>, 394875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar childEntity : String, childColumns: List<String>): String { 395875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar return """ 396875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar $childEntity has a foreign key (${childColumns.joinToString(",")}) that references 397875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar $parentEntity (${parentColumns.joinToString(",")}) but $parentEntity does not have 398875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar a unique index on those columns nor the columns are its primary key. 399875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar SQLite requires having a unique constraint on referenced parent columns so you must 400875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar add a unique index to $parentEntity that has 401875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar (${parentColumns.joinToString(",")}) column(s). 402875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar """.trim() 403875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar } 404875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar 405875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar fun foreignKeyMissingIndexInChildColumns(childColumns: List<String>) : String { 406875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar return """ 407875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar (${childColumns.joinToString(",")}) column(s) reference a foreign key but 408875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar they are not part of an index. This may trigger full table scans whenever parent 409875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar table is modified so you are highly advised to create an index that covers these 410875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar columns. 411875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar """.trim() 412875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar } 413875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar 414875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar fun foreignKeyMissingIndexInChildColumn(childColumn: String) : String { 415875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar return """ 416875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar $childColumn column references a foreign key but it is not part of an index. This 417875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar may trigger full table scans whenever parent table is modified so you are highly 418875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar advised to create an index that covers this column. 419875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar """.trim() 420875203d39f95be2367dec3ee70be4e2169b4e0f0Yigit Boyar } 42108ddf77b7cc743f85b23e83de8b22b69fe4bf6d2Yigit Boyar 42208ddf77b7cc743f85b23e83de8b22b69fe4bf6d2Yigit Boyar fun shortcutEntityIsNotInDatabase(database : String, dao : String, entity : String) : String { 42308ddf77b7cc743f85b23e83de8b22b69fe4bf6d2Yigit Boyar return """ 42408ddf77b7cc743f85b23e83de8b22b69fe4bf6d2Yigit Boyar $dao is part of $database but this entity is not in the database. Maybe you forgot 42508ddf77b7cc743f85b23e83de8b22b69fe4bf6d2Yigit Boyar to add $entity to the entities section of the @Database? 42608ddf77b7cc743f85b23e83de8b22b69fe4bf6d2Yigit Boyar """.trim() 42708ddf77b7cc743f85b23e83de8b22b69fe4bf6d2Yigit Boyar } 4283c592c4ccbc6052b11443b0fa575052c08fefa55Yigit Boyar val MISSING_ROOM_RXJAVA2_ARTIFACT = "To use RxJava2 features, you must add `rxjava2`" + 42964db0cc15b78b62a1d44a70fc8b4552e660d952cYigit Boyar " artifact from Room as a dependency. android.arch.persistence.room:rxjava2:<version>" 430f8c3624579d5761a2d34a7199932492d267f5f85Yigit Boyar 431f8c3624579d5761a2d34a7199932492d267f5f85Yigit Boyar fun ambigiousConstructor(pojo : String, paramName:String, matchingFields : List<String>) 432f8c3624579d5761a2d34a7199932492d267f5f85Yigit Boyar : String { 433f8c3624579d5761a2d34a7199932492d267f5f85Yigit Boyar return """ 434f8c3624579d5761a2d34a7199932492d267f5f85Yigit Boyar Ambiguous constructor. The parameter ($paramName) in $pojo matches multiple fields: 435f8c3624579d5761a2d34a7199932492d267f5f85Yigit Boyar [${matchingFields.joinToString(",")}]. If you don't want to use this constructor, 436f8c3624579d5761a2d34a7199932492d267f5f85Yigit Boyar you can annotate it with @Ignore. If you want Room to use this constructor, you can 437f8c3624579d5761a2d34a7199932492d267f5f85Yigit Boyar rename the parameters to exactly match the field name to fix the ambiguity. 438f8c3624579d5761a2d34a7199932492d267f5f85Yigit Boyar """.trim() 439f8c3624579d5761a2d34a7199932492d267f5f85Yigit Boyar } 440f8c3624579d5761a2d34a7199932492d267f5f85Yigit Boyar 441f8c3624579d5761a2d34a7199932492d267f5f85Yigit Boyar val MISSING_POJO_CONSTRUCTOR = """ 442f8c3624579d5761a2d34a7199932492d267f5f85Yigit Boyar Entities and Pojos must have a usable public constructor. You can have an empty 443f8c3624579d5761a2d34a7199932492d267f5f85Yigit Boyar constructor or a constructor whose parameters match the fields (by name and type). 444f8c3624579d5761a2d34a7199932492d267f5f85Yigit Boyar """.trim() 445f8c3624579d5761a2d34a7199932492d267f5f85Yigit Boyar 446f8c3624579d5761a2d34a7199932492d267f5f85Yigit Boyar val TOO_MANY_POJO_CONSTRUCTORS = """ 447f8c3624579d5761a2d34a7199932492d267f5f85Yigit Boyar Room cannot pick a constructor since multiple constructors are suitable. Try to annotate 448f8c3624579d5761a2d34a7199932492d267f5f85Yigit Boyar unwanted constructors with @Ignore. 449f8c3624579d5761a2d34a7199932492d267f5f85Yigit Boyar """.trim() 450abd098954d3fe996f336201ccb25884aaa34e07fYigit Boyar 451abd098954d3fe996f336201ccb25884aaa34e07fYigit Boyar val PAGING_SPECIFY_DATA_SOURCE_TYPE = "For now, Room only supports TiledDataSource class." 45219b41105359a52aeb80070dec40247241231f05dYigit Boyar} 453