src/main/java/net/pterodactylus/rhynodge/states/StringState.java

   1 /*
   2  * rhynodge - StringState.java - Copyright © 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.rhynodge.states;
  19
  20 import javax.annotation.Nonnull;
  21
  22 /**
  23  * A {@link net.pterodactylus.rhynodge.State} that stores a single {@link
  24  * String} value.
  25  *
  26  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  27  */
  28 public class StringState extends AbstractState {
  29
  30         /** The string value. */
  31         private final String value;
  32
  33         /**
  34          * Creates a new string state.
  35          *
  36          * @param value
  37          *              The value of the state
  38          */
  39         public StringState(String value) {
  40                 this.value = value;
  41         }
  42
  43         /**
  44          * Returns the string value of this state.
  45          *
  46          * @return The string value
  47          */
  48         public String value() {
  49                 return value;
  50         }
  51
  52         @Override
  53         public boolean isEmpty() {
  54                 return value.isEmpty();
  55         }
  56
  57         @Nonnull
  58         @Override
  59         protected String plainText() {
  60                 return value;
  61         }
  62
  63 }