Coverage Report

Coverage Report - com.allanbank.mongodb.builder.write.WriteOperation

Classes in this File

 /*
  * #%L
  * WriteOperation.java - mongodb-async-driver - Allanbank Consulting, Inc.
  * %%
  * Copyright (C) 2011 - 2014 Allanbank Consulting, 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.
  * #L%
  */
 
 package com.allanbank.mongodb.builder.write;
 
 import java.io.Serializable;
 
 import com.allanbank.mongodb.bson.Document;
 
 /**
  * WriteOperation provides a common interface for all types of writes:
  * {@link InsertOperation inserts}, {@link UpdateOperation updates}, and
  * {@link DeleteOperation deletes}.
  * 
  * @api.yes This interface is part of the driver's API. Public and protected
  *          members will be deprecated for at least 1 non-bugfix release
  *          (version numbers are &lt;major&gt;.&lt;minor&gt;.&lt;bugfix&gt;)
  *          before being removed or modified.
  * @copyright 2014, Allanbank Consulting, Inc., All Rights Reserved
  */
 public interface WriteOperation extends Serializable {
     /**
      * Returns the document that should be used to route the write operation.
      * 
      * @return The document that should be used to route the write operation.
      */
     public Document getRoutingDocument();
 
     /**
      * Returns the type of write. Can be used to avoid instance of calls and in
      * switch statements.
      * 
      * @return The type of write.
      */
     public WriteOperationType getType();
 }

1		/*
2		* #%L
3		* WriteOperation.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.builder.write;
22
23		import java.io.Serializable;
24
25		import com.allanbank.mongodb.bson.Document;
26
27		/**
28		* WriteOperation provides a common interface for all types of writes:
29		* {@link InsertOperation inserts}, {@link UpdateOperation updates}, and
30		* {@link DeleteOperation deletes}.
31		*
32		* @api.yes This interface is part of the driver's API. Public and protected
33		* members will be deprecated for at least 1 non-bugfix release
34		* (version numbers are <major>.<minor>.<bugfix>)
35		* before being removed or modified.
36		* @copyright 2014, Allanbank Consulting, Inc., All Rights Reserved
37		*/
38		public interface WriteOperation extends Serializable {
39		/**
40		* Returns the document that should be used to route the write operation.
41		*
42		* @return The document that should be used to route the write operation.
43		*/
44		public Document getRoutingDocument();
45
46		/**
47		* Returns the type of write. Can be used to avoid instance of calls and in
48		* switch statements.
49		*
50		* @return The type of write.
51		*/
52		public WriteOperationType getType();
53		}