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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
/*
* Copyright (C) 2018 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.textclassifier.common.logging;
import androidx.annotation.NonNull;
import com.google.common.base.Preconditions;
import java.util.Locale;
import javax.annotation.Nullable;
/** A representation of the context in which text classification would be performed. */
public final class TextClassificationContext {
private final String packageName;
private final String widgetType;
@Nullable private final String widgetVersion;
private TextClassificationContext(
String packageName, String widgetType, @Nullable String widgetVersion) {
this.packageName = Preconditions.checkNotNull(packageName);
this.widgetType = Preconditions.checkNotNull(widgetType);
this.widgetVersion = widgetVersion;
}
/** Returns the package name for the calling package. */
public String getPackageName() {
return packageName;
}
/** Returns the widget type for this classification context. */
public String getWidgetType() {
return widgetType;
}
/**
* Returns a custom version string for the widget type.
*
* @see #getWidgetType()
*/
@Nullable
public String getWidgetVersion() {
return widgetVersion;
}
@Override
public String toString() {
return String.format(
Locale.US,
"TextClassificationContext{" + "packageName=%s, widgetType=%s, widgetVersion=%s}",
packageName,
widgetType,
widgetVersion);
}
/** A builder for building a TextClassification context. */
public static final class Builder {
private final String packageName;
private final String widgetType;
@Nullable private String widgetVersion;
/**
* Initializes a new builder for text classification context objects.
*
* @param packageName the name of the calling package
* @param widgetType the type of widget e.g. {@link
* android.view.textclassifier.TextClassifier#WIDGET_TYPE_TEXTVIEW}
* @return this builder
*/
public Builder(String packageName, String widgetType) {
this.packageName = Preconditions.checkNotNull(packageName);
this.widgetType = Preconditions.checkNotNull(widgetType);
}
/**
* Sets an optional custom version string for the widget type.
*
* @return this builder
*/
public Builder setWidgetVersion(@Nullable String widgetVersion) {
this.widgetVersion = widgetVersion;
return this;
}
/**
* Builds the text classification context object.
*
* @return the built TextClassificationContext object
*/
@NonNull
public TextClassificationContext build() {
return new TextClassificationContext(packageName, this.widgetType, widgetVersion);
}
}
}
|
