Update years in copyright line

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

diff --git a/src/main/java/net/pterodactylus/sone/text/SonePart.java b/src/main/java/net/pterodactylus/sone/text/SonePart.java
index b460a29..3d3e666 100644 (file)
--- a/src/main/java/net/pterodactylus/sone/text/SonePart.java
+++ b/src/main/java/net/pterodactylus/sone/text/SonePart.java
@@ -1,5 +1,5 @@
 /*
- * Sone - SoneLinkPart.java - Copyright © 2011 David Roden
+ * Sone - SonePart.java - Copyright © 2011–2015 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
@@ -21,20 +21,48 @@ import net.pterodactylus.sone.data.Sone;
 import net.pterodactylus.sone.template.SoneAccessor;
 
 /**
- * TODO
+ * {@link Part} implementation that stores a reference to a {@link Sone}.
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
 public class SonePart implements Part {
 
+       /** The referenced {@link Sone}. */
        private final Sone sone;
 
+       /**
+        * Creates a new Sone part.
+        *
+        * @param sone
+        *            The referenced Sone
+        */
        public SonePart(Sone sone) {
                this.sone = sone;
        }
 
+       //
+       // ACCESSORS
+       //
+
+       /**
+        * Returns the referenced Sone.
+        *
+        * @return The referenced Sone
+        */
        public Sone getSone() {
                return sone;
        }
 
+       //
+       // PART METHODS
+       //
+
+       /**
+        * {@inheritDoc}
+        */
+       @Override
+       public String getText() {
+               return SoneAccessor.getNiceName(sone);
+       }
+
 }