/*
- * Sone - LinkPart.java - Copyright © 2011 David Roden
+ * Sone - LinkPart.java - Copyright © 2011–2013 David Roden
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
package net.pterodactylus.sone.text;
/**
- * TODO
+ * {@link Part} implementation that can hold a link. A link contains of three
+ * attributes: the link itself, the text that is shown instead of the link, and
+ * an explanatory text that can be displayed e.g. as a tooltip.
*
* @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
public class LinkPart implements Part {
+ /** The link of this part. */
private final String link;
+
+ /** The text of this part. */
private final String text;
+
+ /** The title of this part. */
private final String title;
+ /**
+ * Creates a new link part.
+ *
+ * @param link
+ * The link of the link part
+ * @param text
+ * The text of the link part
+ */
public LinkPart(String link, String text) {
this(link, text, text);
}
+ /**
+ * Creates a new link part.
+ *
+ * @param link
+ * The link of the link part
+ * @param text
+ * The text of the link part
+ * @param title
+ * The title of the link part
+ */
public LinkPart(String link, String text, String title) {
this.link = link;
this.text = text;
// ACCESSORS
//
+ /**
+ * Returns the link of this part.
+ *
+ * @return The link of this part
+ */
public String getLink() {
return link;
}
- public String getText() {
- return text;
- }
-
+ /**
+ * Returns the title of this part.
+ *
+ * @return The title of this part
+ */
public String getTitle() {
return title;
}
+ //
+ // PART METHODS
+ //
+
+ /**
+ * Returns the text of this part.
+ *
+ * @return The text of this part
+ */
+ @Override
+ public String getText() {
+ return text;
+ }
+
}