org.bson.BSONObject Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sequoiadb-driver Show documentation
Java client driver for SequoiaDB
There is a newer version: 5.10
// BSONObject.java

/**
 *      Copyright (C) 2008 10gen Inc.
 *
 *   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
 *
 *      http://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.bson;

import java.io.Serializable;
import java.lang.reflect.Type;
import java.util.Map;
import java.util.Set;

/**
 * A key-value map that can be saved to the database.
 */
public interface BSONObject extends Serializable {

	/**
	 * Sets a name/value pair in this object.
	 * 
	 * @param key
	 *            Name to set
	 * @param v
	 *            Corresponding value
	 * @return v
	 */
	public Object put(String key, Object v);

	/**
	 * Sets a name/value(Basic Type) pair in this object.
	 * 
	 * @param key
	 *            Name to set
	 * @param v
	 *            Corresponding value
	 * @return v
	 */
	// public  boolean putBasicType(String key, T object);

	/**
	 * Sets all key/value pairs from an object into this object
	 * 
	 * @param o
	 *            the object
	 */
	public void putAll(BSONObject o);

	/**
	 * Sets all key/value pairs from an object into this object if the keys don't exist.
	 *
	 * @param o
	 *            the object
	 */
	public void putAllUnique(BSONObject o);

	/**
	 * The current bson object keeps any elements or not
	 * 
	 * @return true for empty, false for not
	 */
	public boolean isEmpty();

	/**
	 * Sets all key/value pairs from a map into this object
	 * 
	 * @param m
	 *            the map
	 */
	@SuppressWarnings("rawtypes")
	public void putAll(Map m);

	/**
	 * Sets all key/value pairs from a map into this object if the keys don't exist.
	 *
	 * @param m
	 *            the map
	 */
	public void putAllUnique(Map m);

	/**
	 * Gets a field from this object by a given name.
	 * 
	 * @param key
	 *            The name of the field fetch
	 * @return The field, if found
	 */
	public Object get(String key);

	/**
	 * Returns a map representing this BSONObject.
	 * 
	 * @return the map
	 */
	@SuppressWarnings("rawtypes")
	public Map toMap();

	/**
	 * Removes a field with a given name from this object.
	 * 
	 * @param key
	 *            The name of the field to remove
	 * @return The value removed from this object
	 */
	public Object removeField(String key);

	/**
	 * Deprecated
	 * 
	 * @param s
	 * @return True if the key is present
	 * @deprecated
	 */
	@Deprecated
	public boolean containsKey(String s);

	/**
	 * Checks if this object contains a field with the given name.
	 * 
	 * @param s
	 *            Field name for which to check
	 * @return True if the field is present
	 */
	public boolean containsField(String s);

	/**
	 * Returns this object's fields' names
	 * 
	 * @return The names of the fields in this object
	 */
	public Set keySet();

	/**
	 * Return an instance of the class "cls", only for BasicBSONObject.
	 * @param cls target class object
	 * @return the instance of the class
	 * @throws Exception If error happens.
	 */
	public /*! @cond x*/  /*! @endcond */ T as(Class cls, Type eleType) throws Exception;

	/**
     * Return an instance of the class "cls", only for BasicBSONObject.
	 * @param cls target class object
	 * @return the instance of the class
	 * @throws Exception If error happens.
	 */
	public /*! @cond x*/  /*! @endcond */ T as(Class cls) throws Exception;

}