1 /*
2 * #%L
3 * Builder.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.bson.builder;
21
22 /**
23 * Common interface for all builders.
24 *
25 * @api.yes This interface is part of the driver's API. Public and protected
26 * members will be deprecated for at least 1 non-bugfix release
27 * (version numbers are <major>.<minor>.<bugfix>)
28 * before being removed or modified.
29 * @copyright 2011-2013, Allanbank Consulting, Inc., All Rights Reserved
30 */
31 public interface Builder {
32 /**
33 * Pops the sub-context. Since the outer context might be an array or a
34 * document the appropriate builder type cannot be returned and the user
35 * must maintain the appropriate outer scoped builder.
36 *
37 * @return The outer scoped builder.
38 */
39 public Builder pop();
40
41 /**
42 * Resets the builder back to an empty state.
43 *
44 * @return This builder for method call chaining.
45 */
46 public Builder reset();
47 }