src/main/java/net/pterodactylus/sone/text/Part.java

   1 /*
   2  * Sone - Part.java - Copyright © 2010–2013 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 /**
  21  * A part is a single piece of information that can be displayed as a single
  22  * element. How the part is displayed is not part of the {@code Part}
  23  * specification.
  24  *
  25  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  26  */
  27 public interface Part {
  28
  29         /**
  30          * Returns the text contained in this part. This should return plain text
  31          * without any format information.
  32          *
  33          * @return The plain text of this part
  34          */
  35         public String getText();
  36
  37 }