1 /*
2 * (c) Copyright 2006-2020 by rapiddweller GmbH & Volker Bergmann. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, is permitted under the terms of the
6 * GNU General Public License.
7 *
8 * For redistributing this software or a derivative work under a license other
9 * than the GPL-compatible Free Software License as defined by the Free
10 * Software Foundation or approved by OSI, you must first obtain a commercial
11 * license to this software product from rapiddweller GmbH & Volker Bergmann.
12 *
13 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
14 * WITHOUT A WARRANTY OF ANY KIND. ALL EXPRESS OR IMPLIED CONDITIONS,
15 * REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF
16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE
17 * HEREBY EXCLUDED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
18 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24 * POSSIBILITY OF SUCH DAMAGE.
25 */
26
27 package com.rapiddweller.benerator.primitive;
28
29 import com.rapiddweller.benerator.util.ThreadSafeNonNullGenerator;
30
31 import java.util.Random;
32
33 /**
34 * Generates boolean values with a configurable quota of true values.<br/>
35 * <br/>
36 * Created: 09.06.2006 20:03:18
37 */
38 public class BooleanGenerator extends ThreadSafeNonNullGenerator<Boolean> {
39
40 /**
41 * The quota of true values to create
42 */
43 private double trueQuota;
44
45 private final Random random;
46
47 // constructors ----------------------------------------------------------------------------------------------------
48
49 /**
50 * Initializes the generator to a trueQuota of 50%
51 */
52 public BooleanGenerator() {
53 this(0.5f);
54 }
55
56 /**
57 * Initializes the generator to a trueQuota
58 *
59 * @param trueQuota the true quota
60 */
61 public BooleanGenerator(double trueQuota) {
62 this.trueQuota = trueQuota;
63 this.random = new Random();
64 }
65
66 // config properties -----------------------------------------------------------------------------------------------
67
68 /**
69 * Sets the quota of true values to create
70 *
71 * @return the true quota
72 */
73 public double getTrueQuota() {
74 return trueQuota;
75 }
76
77 /**
78 * Returns the quota of true values to create
79 *
80 * @param trueQuota the true quota
81 */
82 public void setTrueQuota(double trueQuota) {
83 this.trueQuota = trueQuota;
84 }
85
86 // Generator interface ---------------------------------------------------------------------------------------------
87
88 @Override
89 public Class<Boolean> getGeneratedType() {
90 return Boolean.class;
91 }
92
93 /**
94 * generates boolean values with a quota of true values according to the trueQuota property
95 */
96 @Override
97 public Boolean generate() {
98 return (random.nextFloat() <= trueQuota);
99 }
100
101 // java.lang.Object overrides --------------------------------------------------------------------------------------
102
103 @Override
104 public String toString() {
105 return getClass().getSimpleName() + "[trueQuota=" + trueQuota + ']';
106 }
107
108 }