File: Capability.java

package info (click to toggle)
android-platform-frameworks-base 1%3A14~beta1-4
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 326,084 kB
  • sloc: java: 2,032,373; xml: 343,016; cpp: 304,181; python: 3,683; ansic: 2,090; sh: 1,871; makefile: 120; sed: 19
file content (143 lines) | stat: -rw-r--r-- 3,989 bytes parent folder | download | duplicates (3)
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
/*
 * 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 android.content.pm;

import android.annotation.NonNull;
import android.os.Parcel;
import android.os.Parcelable;

import java.util.Objects;

/**
 * Represents a capability that can be performed by an app, also known as App Action.
 * Capabilities can be associated with a {@link ShortcutInfo}.
 *
 * @see ShortcutInfo.Builder#addCapabilityBinding(Capability, CapabilityParams)
 */
public final class Capability implements Parcelable {

    @NonNull
    private final String mName;

    /**
     * Constructor.
     * @param name Name of the capability, usually maps to a built-in intent,
     *            e.g. actions.intent.GET_MESSAGE. Note the character "/" is not permitted.
     * @throws IllegalArgumentException If specified capability name contains the character "/".
     *
     * @hide
     */
    Capability(@NonNull final String name) {
        Objects.requireNonNull(name);
        if (name.contains("/")) {
            throw new IllegalArgumentException("'/' is not permitted in the capability name");
        }
        mName = name;
    }

    /**
     * Copy constructor.
     *
     * @hide
     */
    Capability(@NonNull final Capability orig) {
        this(orig.mName);
    }

    private Capability(@NonNull final Builder builder) {
        this(builder.mName);
    }

    private Capability(@NonNull final Parcel in) {
        mName = in.readString();
    }

    /**
     * Returns the name of the capability. e.g. actions.intent.GET_MESSAGE.
     */
    @NonNull
    public String getName() {
        return mName;
    }

    @Override
    public boolean equals(Object obj) {
        if (!(obj instanceof Capability)) {
            return false;
        }
        return mName.equals(((Capability) obj).mName);
    }

    @Override
    public int hashCode() {
        return mName.hashCode();
    }

    @Override
    public void writeToParcel(@NonNull Parcel dest, int flags) {
        dest.writeString(mName);
    }
    @Override
    public int describeContents() {
        return 0;
    }

    @NonNull
    public static final Parcelable.Creator<Capability> CREATOR =
            new Parcelable.Creator<Capability>() {
        @Override
        public Capability[] newArray(int size) {
            return new Capability[size];
        }

        @Override
        public Capability createFromParcel(@NonNull Parcel in) {
            return new Capability(in);
        }
    };

    /**
     * Builder class for {@link Capability}.
     */
    public static final class Builder {

        @NonNull
        private final String mName;

        /**
         * Constructor.
         * @param name Name of the capability, usually maps to a built-in intent,
         *            e.g. actions.intent.GET_MESSAGE. Note the character "/" is not permitted.
         * @throws IllegalArgumentException If specified capability name contains the character "/".
         */
        public Builder(@NonNull final String name) {
            Objects.requireNonNull(name);
            if (name.contains("/")) {
                throw new IllegalArgumentException("'/' is not permitted in the capability name");
            }
            mName = name;
        }

        /**
         * Creates an instance of {@link Capability}
         */
        @NonNull
        public Capability build() {
            return new Capability(this);
        }
    }
}