Coverage Report

Coverage Report - com.allanbank.mongodb.bson.element.BooleanElement

Classes in this File

Line Coverage

Branch Coverage

Complexity

BooleanElement

100%

34/34

100%

20/20

1.833

 /*
  * #%L
  * BooleanElement.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.bson.element;
 
 import com.allanbank.mongodb.bson.Element;
 import com.allanbank.mongodb.bson.ElementType;
 import com.allanbank.mongodb.bson.Visitor;
 import com.allanbank.mongodb.bson.io.StringEncoder;
 
 /**
  * A wrapper for a BSON boolean.
  * 
  * @api.yes This class 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 2011-2013, Allanbank Consulting, Inc., All Rights Reserved
  */
 public class BooleanElement extends AbstractElement {
 
     /** The BSON type for a Object Id. */
     public static final ElementType TYPE = ElementType.BOOLEAN;
 
     /** Serialization version for the class. */
     private static final long serialVersionUID = -3534279865960686134L;
 
     /**
      * Computes and returns the number of bytes that are used to encode the
      * element.
      * 
      * @param name
      *            The name for the element.
      * @return The size of the element when encoded in bytes.
      */
     private static long computeSize(final String name) {
         long result = 3; // type (1) + name null byte (1) + value (1).
         result += StringEncoder.utf8Size(name);
 
         return result;
     }
 
     /** The boolean value */
     private final boolean myValue;
 
     /**
      * Constructs a new {@link BooleanElement}.
      * 
      * @param name
      *            The name for the BSON boolean.
      * @param value
      *            The BSON boolean value.
      * @throws IllegalArgumentException
      *             If the {@code name} is <code>null</code>.
      */
     public BooleanElement(final String name, final boolean value) {
         this(name, value, computeSize(name));
     }
 
     /**
      * Constructs a new {@link BooleanElement}.
      * 
      * @param name
      *            The name for the BSON boolean.
      * @param value
      *            The BSON boolean value.
      * @param size
      *            The size of the element when encoded in bytes. If not known
      *            then use the
      *            {@link BooleanElement#BooleanElement(String, boolean)}
      *            constructor instead.
      * @throws IllegalArgumentException
      *             If the {@code name} is <code>null</code>.
      */
     public BooleanElement(final String name, final boolean value,
             final long size) {
         super(name, size);
         myValue = value;
     }
 
     /**
      * Accepts the visitor and calls the {@link Visitor#visitBoolean} method.
      * 
      * @see Element#accept(Visitor)
      */
     @Override
     public void accept(final Visitor visitor) {
         visitor.visitBoolean(getName(), getValue());
     }
 
     /**
      * {@inheritDoc}
      * <p>
      * Overridden to compare the values if the base class comparison is equals.
      * False is less than true.
      * </p>
      */
     @Override
     public int compareTo(final Element otherElement) {
         int result = super.compareTo(otherElement);
 
         if (result == 0) {
             final BooleanElement other = (BooleanElement) otherElement;
 
             final int value = myValue ? 1 : 0;
             final int otherValue = other.myValue ? 1 : 0;
 
             result = value - otherValue;
         }
 
         return result;
     }
 
     /**
      * Determines if the passed object is of this same type as this object and
      * if so that its fields are equal.
      * 
      * @param object
      *            The object to compare to.
      * 
      * @see java.lang.Object#equals(java.lang.Object)
      */
     @Override
     public boolean equals(final Object object) {
         boolean result = false;
         if (this == object) {
             result = true;
         }
         else if ((object != null) && (getClass() == object.getClass())) {
             final BooleanElement other = (BooleanElement) object;
 
             result = super.equals(object) && (myValue == other.myValue);
         }
         return result;
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public ElementType getType() {
         return TYPE;
     }
 
     /**
      * Returns the BSON boolean value.
      * 
      * @return The BSON boolean value.
      */
     public boolean getValue() {
         return myValue;
     }
 
     /**
      * {@inheritDoc}
      * <p>
      * Returns a {@link Boolean}.
      * </p>
      */
     @Override
     public Boolean getValueAsObject() {
         return Boolean.valueOf(getValue());
     }
 
     /**
      * {@inheritDoc}
      * <p>
      * Returns "true" or "false".
      * </p>
      */
     @Override
     public String getValueAsString() {
         return Boolean.toString(myValue);
     }
 
     /**
      * Computes a reasonable hash code.
      * 
      * @return The hash code value.
      */
     @Override
     public int hashCode() {
         return super.hashCode() + (myValue ? 31 : 11);
     }
 
     /**
      * {@inheritDoc}
      * <p>
      * Returns a new {@link BooleanElement}.
      * </p>
      */
     @Override
     public BooleanElement withName(final String name) {
         if (getName().equals(name)) {
             return this;
         }
         return new BooleanElement(name, myValue);
     }
 }

1		/*
2		* #%L
3		* BooleanElement.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.element;
21
22		import com.allanbank.mongodb.bson.Element;
23		import com.allanbank.mongodb.bson.ElementType;
24		import com.allanbank.mongodb.bson.Visitor;
25		import com.allanbank.mongodb.bson.io.StringEncoder;
26
27		/**
28		* A wrapper for a BSON boolean.
29		*
30		* @api.yes This class is part of the driver's API. Public and protected members
31		* will be deprecated for at least 1 non-bugfix release (version
32		* numbers are <major>.<minor>.<bugfix>) before being
33		* removed or modified.
34		* @copyright 2011-2013, Allanbank Consulting, Inc., All Rights Reserved
35		*/
36	199	public class BooleanElement extends AbstractElement {
37
38		/** The BSON type for a Object Id. */
39	1	public static final ElementType TYPE = ElementType.BOOLEAN;
40
41		/** Serialization version for the class. */
42		private static final long serialVersionUID = -3534279865960686134L;
43
44		/**
45		* Computes and returns the number of bytes that are used to encode the
46		* element.
47		*
48		* @param name
49		* The name for the element.
50		* @return The size of the element when encoded in bytes.
51		*/
52		private static long computeSize(final String name) {
53	203258	long result = 3; // type (1) + name null byte (1) + value (1).
54	203258	result += StringEncoder.utf8Size(name);
55
56	203258	return result;
57		}
58
59		/** The boolean value */
60		private final boolean myValue;
61
62		/**
63		* Constructs a new {@link BooleanElement}.
64		*
65		* @param name
66		* The name for the BSON boolean.
67		* @param value
68		* The BSON boolean value.
69		* @throws IllegalArgumentException
70		* If the {@code name} is <code>null</code>.
71		*/
72		public BooleanElement(final String name, final boolean value) {
73	203258	this(name, value, computeSize(name));
74	203257	}
75
76		/**
77		* Constructs a new {@link BooleanElement}.
78		*
79		* @param name
80		* The name for the BSON boolean.
81		* @param value
82		* The BSON boolean value.
83		* @param size
84		* The size of the element when encoded in bytes. If not known
85		* then use the
86		* {@link BooleanElement#BooleanElement(String, boolean)}
87		* constructor instead.
88		* @throws IllegalArgumentException
89		* If the {@code name} is <code>null</code>.
90		*/
91		public BooleanElement(final String name, final boolean value,
92		final long size) {
93	203412	super(name, size);
94	203411	myValue = value;
95	203411	}
96
97		/**
98		* Accepts the visitor and calls the {@link Visitor#visitBoolean} method.
99		*
100		* @see Element#accept(Visitor)
101		*/
102		@Override
103		public void accept(final Visitor visitor) {
104	288	visitor.visitBoolean(getName(), getValue());
105	288	}
106
107		/**
108		* {@inheritDoc}
109		* <p>
110		* Overridden to compare the values if the base class comparison is equals.
111		* False is less than true.
112		* </p>
113		*/
114		@Override
115		public int compareTo(final Element otherElement) {
116	4	int result = super.compareTo(otherElement);
117
118	4	if (result == 0) {
119	3	final BooleanElement other = (BooleanElement) otherElement;
120
121	3	final int value = myValue ? 1 : 0;
122	3	final int otherValue = other.myValue ? 1 : 0;
123
124	3	result = value - otherValue;
125		}
126
127	4	return result;
128		}
129
130		/**
131		* Determines if the passed object is of this same type as this object and
132		* if so that its fields are equal.
133		*
134		* @param object
135		* The object to compare to.
136		*
137		* @see java.lang.Object#equals(java.lang.Object)
138		*/
139		@Override
140		public boolean equals(final Object object) {
141	459	boolean result = false;
142	459	if (this == object) {
143	83	result = true;
144		}
145	376	else if ((object != null) && (getClass() == object.getClass())) {
146	346	final BooleanElement other = (BooleanElement) object;
147
148	346	result = super.equals(object) && (myValue == other.myValue);
149		}
150	459	return result;
151		}
152
153		/**
154		* {@inheritDoc}
155		*/
156		@Override
157		public ElementType getType() {
158	43	return TYPE;
159		}
160
161		/**
162		* Returns the BSON boolean value.
163		*
164		* @return The BSON boolean value.
165		*/
166		public boolean getValue() {
167	557	return myValue;
168		}
169
170		/**
171		* {@inheritDoc}
172		* <p>
173		* Returns a {@link Boolean}.
174		* </p>
175		*/
176		@Override
177		public Boolean getValueAsObject() {
178	2	return Boolean.valueOf(getValue());
179		}
180
181		/**
182		* {@inheritDoc}
183		* <p>
184		* Returns "true" or "false".
185		* </p>
186		*/
187		@Override
188		public String getValueAsString() {
189	3	return Boolean.toString(myValue);
190		}
191
192		/**
193		* Computes a reasonable hash code.
194		*
195		* @return The hash code value.
196		*/
197		@Override
198		public int hashCode() {
199	3067	return super.hashCode() + (myValue ? 31 : 11);
200		}
201
202		/**
203		* {@inheritDoc}
204		* <p>
205		* Returns a new {@link BooleanElement}.
206		* </p>
207		*/
208		@Override
209		public BooleanElement withName(final String name) {
210	202	if (getName().equals(name)) {
211	181	return this;
212		}
213	21	return new BooleanElement(name, myValue);
214		}
215		}