RemoveByDocumentIdRequest.java
/*
* Copyright 2020 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 androidx.appsearch.app;
import androidx.annotation.NonNull;
import androidx.collection.ArraySet;
import androidx.core.util.Preconditions;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Set;
/**
* Encapsulates a request to remove documents by namespace and IDs from the
* {@link AppSearchSession} database.
*
* @see AppSearchSession#remove
*/
public final class RemoveByDocumentIdRequest {
private final String mNamespace;
private final Set<String> mIds;
RemoveByDocumentIdRequest(String namespace, Set<String> ids) {
mNamespace = namespace;
mIds = ids;
}
/** Returns the namespace to remove documents from. */
@NonNull
public String getNamespace() {
return mNamespace;
}
/** Returns the set of document IDs attached to the request. */
@NonNull
public Set<String> getIds() {
return Collections.unmodifiableSet(mIds);
}
/**
* Builder for {@link RemoveByDocumentIdRequest} objects.
*
* <p>Once {@link #build} is called, the instance can no longer be used.
*/
public static final class Builder {
private final String mNamespace;
private final Set<String> mIds = new ArraySet<>();
private boolean mBuilt = false;
/** Creates a {@link RemoveByDocumentIdRequest.Builder} instance. */
public Builder(@NonNull String namespace) {
mNamespace = Preconditions.checkNotNull(namespace);
}
/**
* Adds one or more document IDs to the request.
*
* @throws IllegalStateException if the builder has already been used.
*/
@NonNull
public Builder addIds(@NonNull String... ids) {
Preconditions.checkNotNull(ids);
return addIds(Arrays.asList(ids));
}
/**
* Adds a collection of IDs to the request.
*
* @throws IllegalStateException if the builder has already been used.
*/
@NonNull
public Builder addIds(@NonNull Collection<String> ids) {
Preconditions.checkState(!mBuilt, "Builder has already been used");
Preconditions.checkNotNull(ids);
mIds.addAll(ids);
return this;
}
/**
* Builds a new {@link RemoveByDocumentIdRequest}.
*
* @throws IllegalStateException if the builder has already been used.
*/
@NonNull
public RemoveByDocumentIdRequest build() {
Preconditions.checkState(!mBuilt, "Builder has already been used");
mBuilt = true;
return new RemoveByDocumentIdRequest(mNamespace, mIds);
}
}
}