View Javadoc
1   /*
2    * #%L
3    * Callback.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   * Interface for a callback with the result of a MongoDB operation.
24   * <p>
25   * For a lambda friendly version of this interface see {@link LambdaCallback}.
26   * </p>
27   * 
28   * @param <V>
29   *            The type of the operation's result.
30   * 
31   * @api.yes This interface is part of the driver's API. Public and protected
32   *          members will be deprecated for at least 1 non-bugfix release
33   *          (version numbers are &lt;major&gt;.&lt;minor&gt;.&lt;bugfix&gt;)
34   *          before being removed or modified.
35   * @copyright 2011-2013, Allanbank Consulting, Inc., All Rights Reserved
36   */
37  public interface Callback<V> {
38  
39      /**
40       * Called when the MongoDB operation has completed with the result of the
41       * operation.
42       * 
43       * @param result
44       *            The result of the operation.
45       */
46      public void callback(V result);
47  
48      /**
49       * Called when the operation fails due to an exception.
50       * 
51       * @param thrown
52       *            The thrown exception.
53       */
54      public void exception(Throwable thrown);
55  
56  }