View Javadoc
1   /**
2    * This file Copyright (c) 2003-2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.voting.voters;
35  
36  /**
37   * Used to create boolean voters which can't return integer values. You can
38   * stear the returned values by setting the trueValue and falseValue. To inverse
39   * the result of the boolVote method use the not property.
40   *
41   * @param <T> the type of object passed to vote
42   */
43  public abstract class AbstractBoolVoter<T> extends BaseVoterImpl<T> {
44  
45      private int trueValue = 1;
46  
47      private int falseValue = 0;
48  
49      private boolean not;
50  
51      @Override
52      public int vote(T value) {
53          boolean vote = boolVote(value);
54          if (not) {
55              vote = !vote;
56          }
57          return vote ? trueValue : falseValue;
58      }
59  
60      public int getFalseValue() {
61          return this.falseValue;
62      }
63  
64      public void setFalseValue(int negativeVoteValue) {
65          this.falseValue = negativeVoteValue;
66      }
67  
68      public int getTrueValue() {
69          return this.trueValue;
70      }
71  
72      public void setTrueValue(int positiveVoteValue) {
73          this.trueValue = positiveVoteValue;
74      }
75  
76      abstract protected boolean boolVote(T value);
77  
78  
79      public boolean isNot() {
80          return this.not;
81      }
82  
83      public void setNot(boolean not) {
84          this.not = not;
85      }
86  
87      @Override
88      public String toString() {
89          return super.toString() + ": " + (not ? "not" : "");
90      }
91  
92      public int getLevel() {
93          return getTrueValue();
94      }
95  
96      public void setLevel(int level) {
97          setTrueValue(level);
98      }
99  }