/*
- * Sone - Options.java - Copyright © 2010 David Roden
+ * Sone - Options.java - Copyright © 2010–2020 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
import java.util.HashMap;
import java.util.Map;
-import net.pterodactylus.util.validation.Validator;
+import net.pterodactylus.sone.utils.Option;
/**
* Stores various options that influence Sone’s behaviour.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
public class Options {
- /**
- * Contains current and default value of an option.
- *
- * @param <T>
- * The type of the option
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
- */
- public static interface Option<T> {
-
- /**
- * 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.
- *
- * @return The current value of the option
- */
- public T get();
-
- /**
- * Returns the real value of the option. This will also return an unset
- * value (usually {@code null})!
- *
- * @return The real value of the option
- */
- 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) throws IllegalArgumentException;
-
- }
-
- /**
- * Interface for objects that want to be notified when an option changes its
- * value.
- *
- * @param <T>
- * The type of the option
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
- */
- public static interface OptionWatcher<T> {
-
- /**
- * Notifies an object that an option has been changed.
- *
- * @param option
- * The option that has changed
- * @param oldValue
- * The old value of the option
- * @param newValue
- * The new value of the option
- */
- public void optionChanged(Option<T> option, T oldValue, T newValue);
-
- }
-
- /**
- * Basic implementation of an {@link Option} that notifies an
- * {@link OptionWatcher} if the value changes.
- *
- * @param <T>
- * The type of the option
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
- */
- public static class DefaultOption<T> implements Option<T> {
-
- /** The default value. */
- private final T defaultValue;
-
- /** The current value. */
- private volatile T value;
-
- /** The validator. */
- private Validator<T> validator;
-
- /** The option watcher. */
- private final OptionWatcher<T> optionWatcher;
-
- /**
- * Creates a new default option.
- *
- * @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 (may be {@code null})
- */
- public DefaultOption(T defaultValue, Validator<T> validator, OptionWatcher<T> optionWatcher) {
- this.defaultValue = defaultValue;
- this.validator = validator;
- this.optionWatcher = optionWatcher;
- }
-
- /**
- * {@inheritDoc}
- */
- @Override
- public T getDefault() {
- return defaultValue;
- }
-
- /**
- * {@inheritDoc}
- */
- @Override
- public T get() {
- return (value != null) ? value : defaultValue;
- }
-
- /**
- * Returns the real value of the option. This will also return an unset
- * value (usually {@code null})!
- *
- * @return The real value of the option
- */
- @Override
- public T getReal() {
- return value;
- }
-
- /**
- * {@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)) {
- 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>>());
/**
* Adds an {@link Enum} {@link Option}.
*
+ * @param <T>
+ * The enum type
* @param name
* The name of the option
* @param enumOption
* options.<SomeEnum> getEnumOption("SomeEnumOption").get();
* </pre>
*
+ * @param <T>
+ * 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 <T extends Enum<T>> Option<T> getEnumOption(String name) {
return (Option<T>) enumOptions.get(name);
}
projects / Sone.git / blobdiff