src/main/java/net/pterodactylus/fcp/plugin/CalculatedTrust.java

   1 /*
   2  * jFCPlib - CalculatedTrust.java - Copyright © 2009–2014 David Roden
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17  */
  18
  19 package net.pterodactylus.fcp.plugin;
  20
  21 /**
  22  * Container that stores the trust that is calculated by taking all trustees
  23  * and their trust lists into account.
  24  *
  25  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  26  */
  27 public class CalculatedTrust {
  28
  29         /** The calculated trust value. */
  30         private final Byte trust;
  31
  32         /** The calculated score value. */
  33         private final Integer score;
  34
  35         /** The calculated rank. */
  36         private final Integer rank;
  37
  38         /**
  39          * Creates a new calculated trust container.
  40          *
  41          * @param trust
  42          *            The calculated trust value
  43          * @param score
  44          *            The calculated score value
  45          * @param rank
  46          *            The calculated rank of the
  47          */
  48         public CalculatedTrust(Byte trust, Integer score, Integer rank) {
  49                 this.trust = trust;
  50                 this.score = score;
  51                 this.rank = rank;
  52         }
  53
  54         /**
  55          * Returns the calculated trust value.
  56          *
  57          * @return The calculated trust value, or {@code null} if the trust
  58          *         value is not known
  59          */
  60         public Byte getTrust() {
  61                 return trust;
  62         }
  63
  64         /**
  65          * Returns the calculated score value.
  66          *
  67          * @return The calculated score value, or {@code null} if the score
  68          *         value is not known
  69          */
  70         public Integer getScore() {
  71                 return score;
  72         }
  73
  74         /**
  75          * Returns the calculated rank.
  76          *
  77          * @return The calculated rank, or {@code null} if the rank is not known
  78          */
  79         public Integer getRank() {
  80                 return rank;
  81         }
  82
  83 }