Add javadoc comments, remove obsolete imports.

[Sone.git] / src / main / java / net / pterodactylus / sone / text / FreenetLinkPart.java

diff --git a/src/main/java/net/pterodactylus/sone/text/FreenetLinkPart.java b/src/main/java/net/pterodactylus/sone/text/FreenetLinkPart.java
index 2efb380..be3aef9 100644 (file)
--- a/src/main/java/net/pterodactylus/sone/text/FreenetLinkPart.java
+++ b/src/main/java/net/pterodactylus/sone/text/FreenetLinkPart.java
@@ -18,23 +18,57 @@
 package net.pterodactylus.sone.text;
 
 /**
- * TODO
+ * {@link LinkPart} implementation that stores an additional attribute: if the
+ * link is an SSK or USK link and the post was created by an identity that owns
+ * the keyspace in question.
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
 public class FreenetLinkPart extends LinkPart {
 
+       /** Whether the link is trusted. */
        private final boolean trusted;
 
+       /**
+        * Creates a new freenet link part.
+        *
+        * @param link
+        *            The link of the part
+        * @param text
+        *            The text of the part
+        * @param trusted
+        *            {@code true} if the link is trusted, {@code false} otherwise
+        */
        public FreenetLinkPart(String link, String text, boolean trusted) {
                this(link, text, text, trusted);
        }
 
+       /**
+        * Creates a new freenet link part.
+        *
+        * @param link
+        *            The link of the part
+        * @param text
+        *            The text of the part
+        * @param title
+        *            The title of the part
+        * @param trusted
+        *            {@code true} if the link is trusted, {@code false} otherwise
+        */
        public FreenetLinkPart(String link, String text, String title, boolean trusted) {
                super(link, text, title);
                this.trusted = trusted;
        }
 
+       //
+       // ACCESSORS
+       //
+
+       /**
+        * Returns whether the link is trusted.
+        *
+        * @return {@code true} if the link is trusted, {@code false} otherwise
+        */
        public boolean isTrusted() {
                return trusted;
        }