Add method to get the plain text of a part.
[Sone.git] / src / main / java / net / pterodactylus / sone / text / PlainTextPart.java
index 4870bc4..2c29ee2 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Sone - PlainTextPart.java - Copyright © 2011 David Roden
+ * Sone - PlainTextPart.java - Copyright © 2011–2012 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;
 
-import java.io.IOException;
-import java.io.Writer;
-import java.util.Iterator;
-
-import net.pterodactylus.util.collection.ObjectIterator;
-
 /**
- * TODO
+ * {@link Part} implementation that holds a single piece of text.
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
 public class PlainTextPart implements Part {
 
+       /** The text of the part. */
        private final String text;
 
+       /**
+        * Creates a new plain-text part.
+        *
+        * @param text
+        *            The text of the part
+        */
        public PlainTextPart(String text) {
                this.text = text;
        }
 
        //
-       // ACCESSORS
+       // PART METHODS
        //
 
+       /**
+        * Returns the text of this part.
+        *
+        * @return The text of this part
+        */
+       @Override
        public String getText() {
                return text;
        }