View Javadoc
1   /*
2    * #%L
3    * ElementAssignable.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  
21  package com.allanbank.mongodb.bson;
22  
23  /**
24   * ElementAssignable provides a common interface for objects that can be
25   * converted into an {@link Element}.
26   * 
27   * @api.yes This interface is part of the driver's API. Public and protected
28   *          members will be deprecated for at least 1 non-bugfix release
29   *          (version numbers are <major>.<minor>.<bugfix>)
30   *          before being removed or modified.
31   * @copyright 2012-2013, Allanbank Consulting, Inc., All Rights Reserved
32   */
33  public interface ElementAssignable {
34  
35      /**
36       * Converts the object into an {@link Element}.
37       * 
38       * @return The object as an {@link Element}.
39       */
40      public Element asElement();
41  }