| /* |
| * Copyright 2021 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.app.appsearch; |
| |
| import android.annotation.CurrentTimeMillisLong; |
| import android.annotation.NonNull; |
| |
| import java.util.Objects; |
| |
| /** |
| * A request to report usage of a document. |
| * |
| * <p>See {@link AppSearchSession#reportUsage} for a detailed description of usage reporting. |
| * |
| * @see AppSearchSession#reportUsage |
| */ |
| public final class ReportUsageRequest { |
| private final String mNamespace; |
| private final String mDocumentId; |
| private final long mUsageTimestampMillis; |
| |
| ReportUsageRequest( |
| @NonNull String namespace, @NonNull String documentId, long usageTimestampMillis) { |
| mNamespace = Objects.requireNonNull(namespace); |
| mDocumentId = Objects.requireNonNull(documentId); |
| mUsageTimestampMillis = usageTimestampMillis; |
| } |
| |
| /** Returns the namespace of the document that was used. */ |
| @NonNull |
| public String getNamespace() { |
| return mNamespace; |
| } |
| |
| /** Returns the ID of document that was used. */ |
| @NonNull |
| public String getDocumentId() { |
| return mDocumentId; |
| } |
| |
| /** |
| * Returns the timestamp in milliseconds of the usage report (the time at which the document was |
| * used). |
| * |
| * <p>The value is in the {@link System#currentTimeMillis} time base. |
| */ |
| @CurrentTimeMillisLong |
| public long getUsageTimestampMillis() { |
| return mUsageTimestampMillis; |
| } |
| |
| /** Builder for {@link ReportUsageRequest} objects. */ |
| public static final class Builder { |
| private final String mNamespace; |
| private final String mDocumentId; |
| private Long mUsageTimestampMillis; |
| |
| /** |
| * Creates a new {@link ReportUsageRequest.Builder} instance. |
| * |
| * @param namespace The namespace of the document that was used (e.g. from {@link |
| * GenericDocument#getNamespace}. |
| * @param documentId The ID of document that was used (e.g. from {@link |
| * GenericDocument#getId}. |
| */ |
| public Builder(@NonNull String namespace, @NonNull String documentId) { |
| mNamespace = Objects.requireNonNull(namespace); |
| mDocumentId = Objects.requireNonNull(documentId); |
| } |
| |
| /** |
| * Sets the timestamp in milliseconds of the usage report (the time at which the document |
| * was used). |
| * |
| * <p>The value is in the {@link System#currentTimeMillis} time base. |
| * |
| * <p>If unset, this defaults to the current timestamp at the time that the {@link |
| * ReportUsageRequest} is constructed. |
| */ |
| @NonNull |
| public ReportUsageRequest.Builder setUsageTimestampMillis( |
| @CurrentTimeMillisLong long usageTimestampMillis) { |
| mUsageTimestampMillis = usageTimestampMillis; |
| return this; |
| } |
| |
| /** Builds a new {@link ReportUsageRequest}. */ |
| @NonNull |
| public ReportUsageRequest build() { |
| if (mUsageTimestampMillis == null) { |
| mUsageTimestampMillis = System.currentTimeMillis(); |
| } |
| return new ReportUsageRequest(mNamespace, mDocumentId, mUsageTimestampMillis); |
| } |
| } |
| } |