com.mongodb.client.result.DeleteResult Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mongodb-driver-core Show documentation
Show all versions of mongodb-driver-core Show documentation
The Java operations layer for the MongoDB Java Driver.
Third parties can wrap this layer to provide custom higher-level APIs
/*
* Copyright 2008-present MongoDB, Inc.
*
* 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.mongodb.client.result;
/**
* The result of a delete operation. If the delete was unacknowledged, then {@code wasAcknowledged} will return false and all other methods
* will throw {@code UnsupportedOperationException}.
*
* @see com.mongodb.WriteConcern#UNACKNOWLEDGED
* @since 3.0
*/
public abstract class DeleteResult {
/**
* Returns true if the write was acknowledged.
*
* @return true if the write was acknowledged
*/
public abstract boolean wasAcknowledged();
/**
* Gets the number of documents deleted.
*
* @return the number of documents deleted
*/
public abstract long getDeletedCount();
/**
* Create an acknowledged DeleteResult
*
* @param deletedCount the number of documents deleted
* @return an acknowledged DeleteResult
*/
public static DeleteResult acknowledged(final long deletedCount) {
return new AcknowledgedDeleteResult(deletedCount);
}
/**
* Create an unacknowledged DeleteResult
*
* @return an unacknowledged DeleteResult
*/
public static DeleteResult unacknowledged() {
return new UnacknowledgedDeleteResult();
}
private static class AcknowledgedDeleteResult extends DeleteResult {
private final long deletedCount;
AcknowledgedDeleteResult(final long deletedCount) {
this.deletedCount = deletedCount;
}
@Override
public boolean wasAcknowledged() {
return true;
}
@Override
public long getDeletedCount() {
return deletedCount;
}
@Override
public boolean equals(final Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
AcknowledgedDeleteResult that = (AcknowledgedDeleteResult) o;
if (deletedCount != that.deletedCount) {
return false;
}
return true;
}
@Override
public int hashCode() {
return (int) (deletedCount ^ (deletedCount >>> 32));
}
@Override
public String toString() {
return "AcknowledgedDeleteResult{"
+ "deletedCount=" + deletedCount
+ '}';
}
}
private static class UnacknowledgedDeleteResult extends DeleteResult {
@Override
public boolean wasAcknowledged() {
return false;
}
@Override
public long getDeletedCount() {
throw new UnsupportedOperationException("Cannot get information about an unacknowledged delete");
}
@Override
public boolean equals(final Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
return true;
}
@Override
public int hashCode() {
return 0;
}
@Override
public String toString() {
return "UnacknowledgedDeleteResult{}";
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy