1 /*
2 * #%L
3 * StreamCallback.java - mongodb-async-driver - Allanbank Consulting, Inc.
4 * %%
5 * Copyright (C) 2011 - 2014 Allanbank Consulting, Inc.
6 * %%
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * #L%
19 */
20 package com.allanbank.mongodb;
21
22 /**
23 * Extension of the {@link Callback} interface to provide the ability to notify
24 * callers when the stream is done.
25 *
26 * @param <V>
27 * The type of the operations result.
28 *
29 * @api.yes This interface is part of the driver's API. Public and protected
30 * members will be deprecated for at least 1 non-bugfix release
31 * (version numbers are <major>.<minor>.<bugfix>)
32 * before being removed or modified.
33 * @copyright 2013, Allanbank Consulting, Inc., All Rights Reserved
34 */
35 public interface StreamCallback<V> extends Callback<V> {
36
37 /**
38 * Called when the stream of MongoDB documents has been exhausted.
39 */
40 public void done();
41 }