From dce4ee6592d33854cb118014f8ff0fc2fd5e1124 Mon Sep 17 00:00:00 2001 From: =?utf8?q?David=20=E2=80=98Bombe=E2=80=99=20Roden?= Date: Wed, 2 Jan 2013 11:06:52 +0100 Subject: [PATCH] Add abstract State implementation. --- .../reactor/states/AbstractState.java | 98 ++++++++++++++++++++++ 1 file changed, 98 insertions(+) create mode 100644 src/main/java/net/pterodactylus/reactor/states/AbstractState.java diff --git a/src/main/java/net/pterodactylus/reactor/states/AbstractState.java b/src/main/java/net/pterodactylus/reactor/states/AbstractState.java new file mode 100644 index 0000000..e35c933 --- /dev/null +++ b/src/main/java/net/pterodactylus/reactor/states/AbstractState.java @@ -0,0 +1,98 @@ +/* + * Reactor - AbstractState.java - Copyright © 2013 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 + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package net.pterodactylus.reactor.states; + +import net.pterodactylus.reactor.State; + +/** + * Abstract implementation of a {@link State} that knows about the basic + * attributes of a {@link State}. + * + * @author David ‘Bombe’ Roden + */ +public abstract class AbstractState implements State { + + /** Whether the state was successfully retrieved. */ + private final boolean success; + + /** The optional exception that occured while retrieving the state. */ + private final Throwable exception; + + /** + * Creates a new successful state. + */ + protected AbstractState() { + this(true); + } + + /** + * Creates a new state. + * + * @param success + * {@code true} if the state is successful, {@code false} + * otherwise + */ + protected AbstractState(boolean success) { + this(success, null); + } + + /** + * Creates a new non-successful state with the given exception. + * + * @param exception + * The exception that occured while retrieving the state + */ + protected AbstractState(Throwable exception) { + this(false, exception); + } + + /** + * Creates a new state. + * + * @param success + * {@code true} if the state is successful, {@code false} + * otherwise + * @param exception + * The exception that occured while retrieving the state + */ + protected AbstractState(boolean success, Throwable exception) { + this.success = success; + this.exception = exception; + } + + // + // STATE METHODS + // + + /** + * {@inheritDoc} + */ + @Override + public boolean success() { + return success; + } + + /** + * {@inheritDoc} + */ + @Override + public Throwable exception() { + return exception; + } + +} -- 2.7.4