Set version to 0.8.3.
[Sone.git] / src / main / java / net / pterodactylus / sone / text / SonePart.java
1 /*
2  * Sone - SoneLinkPart.java - Copyright © 2011–2012 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 net.pterodactylus.sone.data.Sone;
21 import net.pterodactylus.sone.template.SoneAccessor;
22
23 /**
24  * {@link Part} implementation that stores a reference to a {@link Sone}.
25  *
26  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
27  */
28 public class SonePart implements Part {
29
30         /** The referenced {@link Sone}. */
31         private final Sone sone;
32
33         /**
34          * Creates a new Sone part.
35          *
36          * @param sone
37          *            The referenced Sone
38          */
39         public SonePart(Sone sone) {
40                 this.sone = sone;
41         }
42
43         //
44         // ACCESSORS
45         //
46
47         /**
48          * Returns the referenced Sone.
49          *
50          * @return The referenced Sone
51          */
52         public Sone getSone() {
53                 return sone;
54         }
55
56         //
57         // PART METHODS
58         //
59
60         /**
61          * {@inheritDoc}
62          */
63         @Override
64         public String getText() {
65                 return SoneAccessor.getNiceName(sone);
66         }
67
68 }