1 /*
2  * Copyright (C) 2017 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 package androidx.room.vo
17 
18 import androidx.room.compiler.processing.XElement
19 import androidx.room.migration.bundle.PrimaryKeyBundle
20 
21 /** Represents a PrimaryKey for an Entity. */
22 data class PrimaryKey(
23     val declaredIn: XElement?,
24     override val properties: Properties,
25     val autoGenerateId: Boolean
26 ) : HasSchemaIdentity, HasProperties {
27     companion object {
28         val MISSING = PrimaryKey(null, Properties(), false)
29     }
30 
toHumanReadableStringnull31     fun toHumanReadableString(): String {
32         return "PrimaryKey[${properties.joinToString(separator = ", ", transform = Property::getPath) }]"
33     }
34 
toBundlenull35     fun toBundle(): PrimaryKeyBundle = PrimaryKeyBundle(autoGenerateId, columnNames)
36 
37     override fun getIdKey() = "$autoGenerateId-$columnNames"
38 }
39