src/main/java/net/pterodactylus/sone/text/SonePart.java

   1 /*
   2  * Sone - SonePart.java - Copyright © 2011–2013 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 3 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, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.sone.text;
  19
  20 import static com.google.common.base.Objects.equal;
  21 import static com.google.common.base.Objects.hashCode;
  22
  23 import net.pterodactylus.sone.data.Sone;
  24 import net.pterodactylus.sone.template.SoneAccessor;
  25
  26 import com.google.common.base.Objects;
  27
  28 /**
  29  * {@link Part} implementation that stores a reference to a {@link Sone}.
  30  *
  31  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  32  */
  33 public class SonePart implements Part {
  34
  35         /** The referenced {@link Sone}. */
  36         private final Sone sone;
  37
  38         /**
  39          * Creates a new Sone part.
  40          *
  41          * @param sone
  42          *            The referenced Sone
  43          */
  44         public SonePart(Sone sone) {
  45                 this.sone = sone;
  46         }
  47
  48         //
  49         // ACCESSORS
  50         //
  51
  52         /**
  53          * Returns the referenced Sone.
  54          *
  55          * @return The referenced Sone
  56          */
  57         public Sone getSone() {
  58                 return sone;
  59         }
  60
  61         //
  62         // PART METHODS
  63         //
  64
  65         @Override
  66         public String getText() {
  67                 return SoneAccessor.getNiceName(sone);
  68         }
  69
  70         @Override
  71         public int hashCode() {
  72                 return Objects.hashCode(sone);
  73         }
  74
  75         @Override
  76         public boolean equals(Object object) {
  77                 if (!(object instanceof SonePart)) {
  78                         return false;
  79                 }
  80                 SonePart sonePart = (SonePart) object;
  81                 return equal(getSone(), sonePart.getSone());
  82         }
  83
  84 }