org.springframework.data.mongodb.core.DocumentCallbackHandler.java Source code

Introduction

Here is the source code for org.springframework.data.mongodb.core.DocumentCallbackHandler.java

Source

/*
 * Copyright 2010-2019 the original 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
 *
 *      https://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.springframework.data.mongodb.core;

import org.bson.Document;
import org.springframework.dao.DataAccessException;

import com.mongodb.MongoException;

/**
 * An interface used by {@link MongoTemplate} for processing documents returned from a MongoDB query on a per-document
 * basis. Implementations of this interface perform the actual work of prcoessing each document but don't need to worry
 * about exception handling. {@MongoException}s will be caught and translated by the calling MongoTemplate An
 * DocumentCallbackHandler is typically stateful: It keeps the result state within the object, to be available later for
 * later inspection.
 *
 * @author Mark Pollack
 * @author Grame Rocher
 * @author Oliver Gierke
 * @author John Brisbin
 * @author Christoph Strobl
 * @since 1.0
 */
public interface DocumentCallbackHandler {

    void processDocument(Document document) throws MongoException, DataAccessException;
}