net.emustudio.emulib.runtime.PluginSettings Maven / Gradle / Ivy
Show all versions of emulib Show documentation
/*
* This file is part of emuLib.
*
* Copyright (C) 2006-2020 Peter Jakubčo
*
* 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
* It is implemented by emuStudio. Plugins obtain this object in the constructor.
*
* NOTE: Keys are case-sensitive.
*
* Keys which are put into settings must not start with {@link PluginSettings#EMUSTUDIO_PREFIX}. This prefix is
* reserved for emuStudio settings and might be overridden by emuStudio.
* However, there are some emuStudio settings obtainable by plugins.
*/
@SuppressWarnings("unused")
public interface PluginSettings {
/**
* EmuStudio key prefix.
*/
String EMUSTUDIO_PREFIX = "emustudio.";
/**
* Setting key defining if emuStudio runs in "No GUI" mode.
*/
String EMUSTUDIO_NO_GUI = EMUSTUDIO_PREFIX + "nogui";
/**
* Setting key defining if emuStudio runs in "Auto" (non-interactive) mode.
*/
String EMUSTUDIO_AUTO = EMUSTUDIO_PREFIX + "auto";
/**
* Check if a key is present in settings.
*
* @param key setting key
* @return true if key is present in settings
*/
boolean contains(String key);
/**
* Remove key from settings if present.
*
* NOTE: If key does not exist already, nothing will happen.
*
* @param key settings key
* @throws CannotUpdateSettingException if the setting could not be removed
*/
void remove(String key) throws CannotUpdateSettingException;
/**
* Get a String value from settings.
*
* @param key settings key
* @return String value if present
*/
Optional getString(String key);
/**
* Get a String value from settings.
*
* @param key settings key
* @param defaultValue default value
* @return String value if present, or defaultValue if not
*/
String getString(String key, String defaultValue);
/**
* Get a boolean value from settings.
*
* @param key settings key
* @return boolean value if present
*/
Optional getBoolean(String key);
/**
* Get a boolean value from settings.
*
* @param key settings key
* @param defaultValue default value
* @return boolean value if present, or defaultValue if not
*/
boolean getBoolean(String key, boolean defaultValue);
/**
* Get an int value from settings.
*
* @param key settings key
* @return int value if present
*/
Optional getInt(String key);
/**
* Get an int value from settings.
*
* @param key settings key
* @param defaultValue default value
* @return int value if present, or defaultValue if not
*/
int getInt(String key, int defaultValue);
/**
* Get a long value from settings.
*
* @param key settings key
* @return long value if present
*/
Optional getLong(String key);
/**
* Get a long value from settings.
*
* @param key settings key
* @param defaultValue default value
* @return long value if present, or defaultValue if not
*/
long getLong(String key, long defaultValue);
/**
* Get a double value from settings.
*
* @param key settings key
* @return double value if present
*/
Optional getDouble(String key);
/**
* Get a double value from settings.
*
* @param key settings key
* @param defaultValue default value
* @return double value if present, or defaultValue if not
*/
double getDouble(String key, double defaultValue);
/**
* Get an array from settings.
*
* @param key settings key
* @return List of String values if the key is present; empty List otherwise
*/
List getArray(String key);
/**
* Get an array from settings.
*
* @param key settings key
* @param defaultValue default value
* @return List of String values if the key is present; default value otherwise
*/
List getArray(String key, List defaultValue);
/**
* Set a String value to the settings.
*
* @param key settings key
* @param value the value
* @throws CannotUpdateSettingException if the setting could not be set
*/
void setString(String key, String value) throws CannotUpdateSettingException;
/**
* Set a boolean value to the settings.
*
* @param key settings key
* @param value the value
* @throws CannotUpdateSettingException if the setting could not be set
*/
void setBoolean(String key, boolean value) throws CannotUpdateSettingException;
/**
* Set an int value to the settings.
*
* @param key settings key
* @param value the value
* @throws CannotUpdateSettingException if the setting could not be set
*/
void setInt(String key, int value) throws CannotUpdateSettingException;
/**
* Set a long value to the settings.
*
* @param key settings key
* @param value the value
* @throws CannotUpdateSettingException if the setting could not be set
*/
void setLong(String key, long value) throws CannotUpdateSettingException;
/**
* Set a double value to the settings.
*
* @param key settings key
* @param value the value
* @throws CannotUpdateSettingException if the setting could not be set
*/
void setDouble(String key, double value) throws CannotUpdateSettingException;
/**
* Set an array to the settings.
*
* @param key settings key
* @param array the value
* @throws CannotUpdateSettingException if the setting could not be set
*/
void setArray(String key, List array) throws CannotUpdateSettingException;
/**
* "Unavailable" instance of PluginSettings.
*
* It means that all methods return dummy or null values.
*
* The instance might be useful when creating plugin object without emuStudio (e.g. a plugin wants to support
* command-line interface).
*/
PluginSettings UNAVAILABLE = new PluginSettings() {
/**
* Returns false.
* @return false
*/
@Override
public boolean contains(String key) {
return false;
}
/**
* Does nothing.
*/
@Override
public void remove(String key) {
}
/**
* Returns Optional.empty().
* @return Optional.empty()
*/
@Override
public Optional getString(String key) {
return Optional.empty();
}
/**
* Returns default value.
*
* @param key settings key
* @param defaultValue default value
* @return defaultValue
*/
@Override
public String getString(String key, String defaultValue) {
return defaultValue;
}
/**
* Returns Optional.empty().
* @return Optional.empty()
*/
@Override
public Optional getBoolean(String key) {
return Optional.empty();
}
/**
* Returns default value.
*
* @param key settings key
* @param defaultValue default value
* @return defaultValue
*/
@Override
public boolean getBoolean(String key, boolean defaultValue) {
return defaultValue;
}
/**
* Returns Optional.empty().
* @return Optional.empty()
*/
@Override
public Optional getInt(String key) {
return Optional.empty();
}
/**
* Returns default value.
*
* @param key settings key
* @param defaultValue default value
* @return defaultValue
*/
@Override
public int getInt(String key, int defaultValue) {
return defaultValue;
}
/**
* Returns Optional.empty().
* @return Optional.empty()
*/
@Override
public Optional getLong(String key) {
return Optional.empty();
}
/**
* Returns default value.
*
* @param key settings key
* @param defaultValue default value
* @return defaultValue
*/
@Override
public long getLong(String key, long defaultValue) {
return defaultValue;
}
/**
* Returns Optional.empty().
* @return Optional.empty()
*/
@Override
public Optional getDouble(String key) {
return Optional.empty();
}
/**
* Returns default value.
*
* @param key settings key
* @param defaultValue default value
* @return defaultValue
*/
@Override
public double getDouble(String key, double defaultValue) {
return defaultValue;
}
/**
* Returns empty list.
* @return empty list
*/
@Override
public List getArray(String key) {
return Collections.emptyList();
}
/**
* Returns default value.
*
* @param key settings key
* @param defaultValue default value
* @return defaultValue
*/
@Override
public List getArray(String key, List defaultValue) {
return defaultValue;
}
/**
* Does nothing.
*/
@Override
public void setString(String key, String value) {
}
/**
* Does nothing.
*/
@Override
public void setBoolean(String key, boolean value) {
}
/**
* Does nothing.
*/
@Override
public void setInt(String key, int value) {
}
/**
* Does nothing.
*/
@Override
public void setLong(String key, long value) {
}
/**
* Does nothing.
*/
@Override
public void setDouble(String key, double value) {
}
/**
* Does nothing.
*/
@Override
public void setArray(String key, List array) {
}
};
}