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 144 145
|
/*
* Copyright (C) 2019 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.view.contentcapture;
import android.annotation.IntDef;
import android.annotation.NonNull;
import android.content.LocusId;
import android.os.Parcel;
import android.os.Parcelable;
import android.util.DebugUtils;
import com.android.internal.util.Preconditions;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
/**
* Defines a condition for when content capture should be allowed.
*
* <p>See {@link ContentCaptureManager#getContentCaptureConditions()} for more.
*/
public final class ContentCaptureCondition implements Parcelable {
/**
* When set, package should use the {@link LocusId#getId()} as a regular expression (using the
* {@link java.util.regex.Pattern} format).
*/
public static final int FLAG_IS_REGEX = 0x2;
/** @hide */
@IntDef(prefix = { "FLAG" }, flag = true, value = {
FLAG_IS_REGEX
})
@Retention(RetentionPolicy.SOURCE)
@interface Flags {}
private final @NonNull LocusId mLocusId;
private final @Flags int mFlags;
/**
* Default constructor.
*
* @param locusId id of the condition, as defined by
* {@link ContentCaptureContext#getLocusId()}.
* @param flags either {@link ContentCaptureCondition#FLAG_IS_REGEX} (to use a regular
* expression match) or {@code 0} (in which case the {@code LocusId} must be an exact match of
* the {@code LocusId} used in the {@link ContentCaptureContext}).
*/
public ContentCaptureCondition(@NonNull LocusId locusId, @Flags int flags) {
this.mLocusId = Preconditions.checkNotNull(locusId);
this.mFlags = flags;
}
/**
* Gets the {@code LocusId} per se.
*/
@NonNull
public LocusId getLocusId() {
return mLocusId;
}
/**
* Gets the flags associates with this condition.
*
* @return either {@link ContentCaptureCondition#FLAG_IS_REGEX} or {@code 0}.
*/
public @Flags int getFlags() {
return mFlags;
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + mFlags;
result = prime * result + ((mLocusId == null) ? 0 : mLocusId.hashCode());
return result;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (getClass() != obj.getClass()) return false;
final ContentCaptureCondition other = (ContentCaptureCondition) obj;
if (mFlags != other.mFlags) return false;
if (mLocusId == null) {
if (other.mLocusId != null) return false;
} else {
if (!mLocusId.equals(other.mLocusId)) return false;
}
return true;
}
@Override
public String toString() {
final StringBuilder string = new StringBuilder(mLocusId.toString()); // LocusID is PII safe
if (mFlags != 0) {
string
.append(" (")
.append(DebugUtils.flagsToString(ContentCaptureCondition.class, "FLAG_", mFlags))
.append(')');
}
return string.toString();
}
@Override
public int describeContents() {
return 0;
}
@Override
public void writeToParcel(@NonNull Parcel parcel, int flags) {
parcel.writeParcelable(mLocusId, flags);
parcel.writeInt(mFlags);
}
public static final @NonNull Parcelable.Creator<ContentCaptureCondition> CREATOR =
new Parcelable.Creator<ContentCaptureCondition>() {
@Override
public ContentCaptureCondition createFromParcel(@NonNull Parcel parcel) {
return new ContentCaptureCondition(parcel.readParcelable(null),
parcel.readInt());
}
@Override
public ContentCaptureCondition[] newArray(int size) {
return new ContentCaptureCondition[size];
}
};
}
|