+/*
+ * Sone - Options.java - Copyright © 2010–2012 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 <http://www.gnu.org/licenses/>.
+ */
+
package net.pterodactylus.sone.core;
+import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
+import net.pterodactylus.util.validation.Validator;
+
/**
* Stores various options that influence Sone’s behaviour.
*
public T getReal();
/**
+ * Validates the given value. Note that {@code null} is always a valid
+ * value!
+ *
+ * @param value
+ * The value to validate
+ * @return {@code true} if this option does not have a {@link Validator}
+ * , or the {@link Validator} validates this object, {@code
+ * false} otherwise
+ */
+ public boolean validate(T value);
+
+ /**
* Sets the current value of the option.
*
* @param value
* The new value of the option
+ * @throws IllegalArgumentException
+ * if the value is not valid for this option
*/
- public void set(T value);
+ public void set(T value) throws IllegalArgumentException;
}
private final T defaultValue;
/** The current value. */
- private T value;
+ private volatile T value;
+
+ /** The validator. */
+ private Validator<T> validator;
/** The option watcher. */
private final OptionWatcher<T> optionWatcher;
*
* @param defaultValue
* The default value of the option
+ */
+ public DefaultOption(T defaultValue) {
+ this(defaultValue, (OptionWatcher<T>) null);
+ }
+
+ /**
+ * Creates a new default option.
+ *
+ * @param defaultValue
+ * The default value of the option
+ * @param validator
+ * The validator for value validation (may be {@code null})
+ */
+ public DefaultOption(T defaultValue, Validator<T> validator) {
+ this(defaultValue, validator, null);
+ }
+
+ /**
+ * Creates a new default option.
+ *
+ * @param defaultValue
+ * The default value of the option
+ * @param optionWatchers
+ * The option watchers (may be {@code null})
+ */
+ public DefaultOption(T defaultValue, OptionWatcher<T> optionWatchers) {
+ this(defaultValue, null, optionWatchers);
+ }
+
+ /**
+ * Creates a new default option.
+ *
+ * @param defaultValue
+ * The default value of the option
+ * @param validator
+ * The validator for value validation (may be {@code null})
* @param optionWatcher
- * The option watcher
+ * The option watcher (may be {@code null})
*/
- public DefaultOption(T defaultValue, OptionWatcher<T> optionWatcher) {
+ public DefaultOption(T defaultValue, Validator<T> validator, OptionWatcher<T> optionWatcher) {
this.defaultValue = defaultValue;
+ this.validator = validator;
this.optionWatcher = optionWatcher;
}
* {@inheritDoc}
*/
@Override
+ public boolean validate(T value) {
+ return (validator == null) || (value == null) || validator.validate(value);
+ }
+
+ /**
+ * {@inheritDoc}
+ */
+ @Override
public void set(T value) {
+ if ((value != null) && (validator != null) && (!validator.validate(value))) {
+ throw new IllegalArgumentException("New Value (" + value + ") could not be validated.");
+ }
T oldValue = this.value;
this.value = value;
if (!get().equals(oldValue)) {
- optionWatcher.optionChanged(this, oldValue, get());
+ if (optionWatcher != null) {
+ optionWatcher.optionChanged(this, oldValue, get());
+ }
}
}
}
+ /** Holds all {@link Boolean} {@link Option}s. */
+ private final Map<String, Option<Boolean>> booleanOptions = Collections.synchronizedMap(new HashMap<String, Option<Boolean>>());
+
/** Holds all {@link Integer} {@link Option}s. */
- private final Map<String, Option<Integer>> integerOptions = new HashMap<String, Option<Integer>>();
+ private final Map<String, Option<Integer>> integerOptions = Collections.synchronizedMap(new HashMap<String, Option<Integer>>());
+
+ /** Holds all {@link String} {@link Option}s. */
+ private final Map<String, Option<String>> stringOptions = Collections.synchronizedMap(new HashMap<String, Option<String>>());
+
+ /** Holds all {@link Enum} {@link Option}s. */
+ private final Map<String, Option<? extends Enum<?>>> enumOptions = Collections.synchronizedMap(new HashMap<String, Option<? extends Enum<?>>>());
+
+ /**
+ * Adds a boolean option.
+ *
+ * @param name
+ * The name of the option
+ * @param booleanOption
+ * The option
+ * @return The given option
+ */
+ public Option<Boolean> addBooleanOption(String name, Option<Boolean> booleanOption) {
+ booleanOptions.put(name, booleanOption);
+ return booleanOption;
+ }
+
+ /**
+ * Returns the boolean option with the given name.
+ *
+ * @param name
+ * The name of the option
+ * @return The option, or {@code null} if there is no option with the given
+ * name
+ */
+ public Option<Boolean> getBooleanOption(String name) {
+ return booleanOptions.get(name);
+ }
/**
* Adds an {@link Integer} {@link Option}.
return integerOptions.get(name);
}
+ /**
+ * Adds a {@link String} {@link Option}.
+ *
+ * @param name
+ * The name of the option
+ * @param stringOption
+ * The option
+ * @return The given option
+ */
+ public Option<String> addStringOption(String name, Option<String> stringOption) {
+ stringOptions.put(name, stringOption);
+ return stringOption;
+ }
+
+ /**
+ * Returns a {@link String} {@link Option}.
+ *
+ * @param name
+ * The name of the string option to get
+ * @return The string option, or {@code null} if there is no option with the
+ * given name
+ */
+ public Option<String> getStringOption(String name) {
+ return stringOptions.get(name);
+ }
+
+ /**
+ * Adds an {@link Enum} {@link Option}.
+ *
+ * @param name
+ * The name of the option
+ * @param enumOption
+ * The option
+ * @return The given option
+ */
+ public <T extends Enum<T>> Option<T> addEnumOption(String name, Option<T> 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:
+ * <p>
+ *
+ * <pre>
+ * options.<SomeEnum> getEnumOption("SomeEnumOption").get();
+ * </pre>
+ *
+ * @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 <T extends Enum<T>> Option<T> getEnumOption(String name) {
+ return (Option<T>) enumOptions.get(name);
+ }
+
}
projects / Sone.git / blobdiff