Rework the text parser.
[Sone.git] / 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 import static net.pterodactylus.sone.template.SoneAccessor.getNiceName;
23
24 import net.pterodactylus.sone.data.Sone;
25 import net.pterodactylus.sone.template.SoneAccessor;
26
27 import com.google.common.base.Objects;
28
29 /**
30  * {@link Part} implementation that stores a reference to a {@link Sone}.
31  *
32  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
33  */
34 public class SonePart implements Part {
35
36         /** The referenced {@link Sone}. */
37         private final Sone sone;
38
39         /**
40          * Creates a new Sone part.
41          *
42          * @param sone
43          *            The referenced Sone
44          */
45         public SonePart(Sone sone) {
46                 this.sone = sone;
47         }
48
49         //
50         // ACCESSORS
51         //
52
53         @Override
54         public boolean isPlainText() {
55                 return false;
56         }
57
58         @Override
59         public boolean isFreenetLink() {
60                 return false;
61         }
62
63         /**
64          * Returns the referenced Sone.
65          *
66          * @return The referenced Sone
67          */
68         public Sone getSone() {
69                 return sone;
70         }
71
72         //
73         // PART METHODS
74         //
75
76         @Override
77         public String getText() {
78                 return getNiceName(sone);
79         }
80
81         @Override
82         public int hashCode() {
83                 return Objects.hashCode(sone);
84         }
85
86         @Override
87         public boolean equals(Object object) {
88                 if (!(object instanceof SonePart)) {
89                         return false;
90                 }
91                 SonePart sonePart = (SonePart) object;
92                 return equal(getSone(), sonePart.getSone());
93         }
94
95 }