summaryrefslogtreecommitdiff
path: root/packages/SystemUI/src/com/android/systemui/common/shared/model/Text.kt
blob: 4a5693202dba1626aa1e88837e6f203d9f2694a6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
/*
 * Copyright (C) 2022 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package com.android.systemui.common.shared.model

import android.annotation.StringRes
import android.content.Context

/**
 * Models a text, that can either be already [loaded][Text.Loaded] or be a [reference]
 * [Text.Resource] to a resource.
 */
sealed class Text {
    data class Loaded(
        val text: String?,
    ) : Text()

    data class Resource(
        @StringRes val res: Int,
    ) : Text()

    companion object {
        /**
         * Returns the loaded test string, or null if we don't have one.
         *
         * Prefer [com.android.systemui.common.ui.binder.TextViewBinder.bind] over this method. This
         * should only be used for testing or concatenation purposes.
         */
        fun Text?.loadText(context: Context): String? {
            return when (this) {
                null -> null
                is Loaded -> this.text
                is Resource -> context.getString(this.res)
            }
        }
    }
}