X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Fcore%2FOptions.java;h=34fc9a3b5d228ebdef52ac9b97026fe92a1cace5;hb=3f91e22e512f81a2e11fa584e30f83da74e62177;hp=b7ece81fe64b8f87e794979c980eda6c3625e45d;hpb=e371dfd08d8b177c097f260f4b1d22b186d8d5b4;p=Sone.git diff --git a/src/main/java/net/pterodactylus/sone/core/Options.java b/src/main/java/net/pterodactylus/sone/core/Options.java index b7ece81..34fc9a3 100644 --- a/src/main/java/net/pterodactylus/sone/core/Options.java +++ b/src/main/java/net/pterodactylus/sone/core/Options.java @@ -1,12 +1,28 @@ +/* + * Sone - Options.java - Copyright © 2010–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.sone.core; -import java.util.ArrayList; -import java.util.Arrays; import java.util.Collections; import java.util.HashMap; -import java.util.List; import java.util.Map; +import com.google.common.base.Predicate; + /** * Stores various options that influence Sone’s behaviour. * @@ -24,13 +40,6 @@ public class Options { public static interface Option { /** - * Returns the default value of the option. - * - * @return The default value of the option - */ - public T getDefault(); - - /** * Returns the current value of the option. If the current value is not * set (usually {@code null}), the default value is returned. * @@ -47,42 +56,30 @@ public class Options { public T getReal(); /** - * Sets the current value of the option. + * Validates the given value. Note that {@code null} is always a valid + * value! * * @param value - * The new value of the option + * The value to validate + * @return {@code true} if this option does not have a validator, or the + * validator validates this object, {@code false} otherwise */ - public void set(T value); - - } - - /** - * Interface for objects that want to be notified when an option changes its - * value. - * - * @param - * The type of the option - * @author David ‘Bombe’ Roden - */ - public static interface OptionWatcher { + public boolean validate(T value); /** - * Notifies an object that an option has been changed. + * Sets the current value of the option. * - * @param option - * The option that has changed - * @param oldValue - * The old value of the option - * @param newValue + * @param value * The new value of the option + * @throws IllegalArgumentException + * if the value is not valid for this option */ - public void optionChanged(Option option, T oldValue, T newValue); + public void set(T value) throws IllegalArgumentException; } /** - * Basic implementation of an {@link Option} that notifies an - * {@link OptionWatcher} if the value changes. + * Basic implementation of an {@link Option}. * * @param * The type of the option @@ -96,28 +93,30 @@ public class Options { /** The current value. */ private volatile T value; - /** The option watcher. */ - private final List> optionWatchers = new ArrayList>(); + /** The validator. */ + private Predicate validator; /** * Creates a new default option. * * @param defaultValue * The default value of the option - * @param optionWatchers - * The option watchers */ - public DefaultOption(T defaultValue, OptionWatcher... optionWatchers) { - this.defaultValue = defaultValue; - this.optionWatchers.addAll(Arrays.asList(optionWatchers)); + public DefaultOption(T defaultValue) { + this(defaultValue, null); } /** - * {@inheritDoc} + * Creates a new default option. + * + * @param defaultValue + * The default value of the option + * @param validator + * The validator for value validation (may be {@code null}) */ - @Override - public T getDefault() { - return defaultValue; + public DefaultOption(T defaultValue, Predicate validator) { + this.defaultValue = defaultValue; + this.validator = validator; } /** @@ -143,14 +142,20 @@ public class Options { * {@inheritDoc} */ @Override + public boolean validate(T value) { + return (validator == null) || (value == null) || validator.apply(value); + } + + /** + * {@inheritDoc} + */ + @Override public void set(T value) { + if ((value != null) && (validator != null) && (!validator.apply(value))) { + throw new IllegalArgumentException("New Value (" + value + ") could not be validated."); + } T oldValue = this.value; this.value = value; - if (!get().equals(oldValue)) { - for (OptionWatcher optionWatcher : optionWatchers) { - optionWatcher.optionChanged(this, oldValue, get()); - } - } } } @@ -164,6 +169,9 @@ public class Options { /** Holds all {@link String} {@link Option}s. */ private final Map> stringOptions = Collections.synchronizedMap(new HashMap>()); + /** Holds all {@link Enum} {@link Option}s. */ + private final Map>> enumOptions = Collections.synchronizedMap(new HashMap>>()); + /** * Adds a boolean option. * @@ -242,4 +250,42 @@ public class Options { return stringOptions.get(name); } + /** + * Adds an {@link Enum} {@link Option}. + * + * @param + * The enum type + * @param name + * The name of the option + * @param enumOption + * The option + * @return The given option + */ + public > Option addEnumOption(String name, Option enumOption) { + enumOptions.put(name, enumOption); + return enumOption; + } + + /** + * Returns a {@link Enum} {@link Option}. As the type can probably not be + * interred correctly you could help the compiler by calling this method + * like this: + *

+ * + *

+	 * options.<SomeEnum> getEnumOption("SomeEnumOption").get();
+	 * 
+ * + * @param + * The enum type + * @param name + * The name of the option + * @return The enum option, or {@code null} if there is no enum option with + * the given name + */ + @SuppressWarnings("unchecked") + public > Option getEnumOption(String name) { + return (Option) enumOptions.get(name); + } + }