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 */
16package androidx.room.vo
17
18import androidx.room.migration.bundle.PrimaryKeyBundle
19import javax.lang.model.element.Element
20
21/**
22 * Represents a PrimaryKey for an Entity.
23 */
24data class PrimaryKey(val declaredIn: Element?, val fields: List<Field>,
25                      val autoGenerateId: Boolean) : HasSchemaIdentity {
26    companion object {
27        val MISSING = PrimaryKey(null, emptyList(), false)
28    }
29
30    val columnNames by lazy { fields.map { it.columnName } }
31
32    fun toHumanReadableString(): String {
33        return "PrimaryKey[" +
34                fields.joinToString(separator = ", ", transform = Field::getPath) + "]"
35    }
36
37    fun toBundle(): PrimaryKeyBundle = PrimaryKeyBundle(
38            autoGenerateId, fields.map { it.columnName })
39
40    override fun getIdKey(): String {
41        return "$autoGenerateId-${fields.map { it.columnName }}"
42    }
43}
44