org.dizitart.no2.common.WriteResult Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2017-2020. Nitrite author or authors.
 *
 * 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 org.dizitart.no2.common;

import org.dizitart.no2.collection.NitriteId;
import org.dizitart.no2.common.util.Iterables;

/**
 * An interface to represent the result of a write operation in Nitrite database.
 * It is an iterable of {@link NitriteId}s of affected documents.
 *
 * @author Anindya Chatterjee
 * @since 1.0
 */
public interface WriteResult extends Iterable {

    /**
     * Gets the number of affected documents by the write operation.
     *
     * @return the affected document count.
     */
    default int getAffectedCount() {
        return (int) Iterables.size(this);
    }
}