Merge branch 'release-0.9.6'
[Sone.git] / src / main / java / net / pterodactylus / sone / text / LinkPart.java
1 /*
2  * Sone - LinkPart.java - Copyright © 2011–2016 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 java.util.Objects;
21
22 import javax.annotation.Nonnull;
23
24 /**
25  * {@link Part} implementation that can hold a link. A link contains of three
26  * attributes: the link itself, the text that is shown instead of the link, and
27  * an explanatory text that can be displayed e.g. as a tooltip.
28  *
29  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
30  */
31 public class LinkPart implements Part {
32
33         private final String link;
34         private final String text;
35         private final String title;
36
37         public LinkPart(@Nonnull String link, @Nonnull String text) {
38                 this(link, text, text);
39         }
40
41         public LinkPart(@Nonnull String link, @Nonnull String text, @Nonnull String title) {
42                 this.link = Objects.requireNonNull(link);
43                 this.text = Objects.requireNonNull(text);
44                 this.title = Objects.requireNonNull(title);
45         }
46
47         @Nonnull
48         public String getLink() {
49                 return link;
50         }
51
52         @Nonnull
53         public String getTitle() {
54                 return title;
55         }
56
57         @Override
58         @Nonnull
59         public String getText() {
60                 return text;
61         }
62
63 }