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

   1 /*
   2  * Rhynodge - FailedState.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 net.pterodactylus.rhynodge.State;
  21
  22 /**
  23  * {@link State} implementation that signals failure.
  24  *
  25  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  26  */
  27 public class FailedState extends AbstractState {
  28
  29         /** A failed state instance without an exception. */
  30         public static final State INSTANCE = new FailedState();
  31
  32         /**
  33          * Creates a new failed state.
  34          */
  35         public FailedState() {
  36                 super(false);
  37         }
  38
  39         /**
  40          * Creates a new failed state with the given exception
  41          *
  42          * @param exception
  43          *            The exception of the state
  44          */
  45         public FailedState(Throwable exception) {
  46                 super(exception);
  47         }
  48
  49         @Override
  50         public boolean isEmpty() {
  51                 return true;
  52         }
  53
  54         //
  55         // STATIC METHODS
  56         //
  57
  58         /**
  59          * Returns a failed state for the given state. The failed state will be
  60          * unsuccessful ({@link #success()} returns false) and it will contain the
  61          * same {@link #exception()} as the given state.
  62          *
  63          * @param state
  64          *            The state to copy the exception from
  65          * @return A failed state
  66          */
  67         public static FailedState from(State state) {
  68                 if (state instanceof FailedState) {
  69                         return (FailedState) state;
  70                 }
  71                 return new FailedState(state.exception());
  72         }
  73
  74         //
  75         // OBJECT METHODS
  76         //
  77
  78         /**
  79          * {@inheritDoc}
  80          */
  81         @Override
  82         public String toString() {
  83                 return String.format("%s[exception=%s]", getClass().getSimpleName(), exception());
  84         }
  85
  86 }