[nikiroo-utils.git] / src / be / nikiroo / fanfix / bundles / Config.java

package be.nikiroo.fanfix.bundles;

import be.nikiroo.utils.resources.Meta;
import be.nikiroo.utils.resources.Meta.Format;

/**
 * The configuration options.
 * 
 * @author niki
 */
@SuppressWarnings("javadoc")
public enum Config {
	@Meta(description = "language (example: en-GB, fr-BE...) or nothing for default system language", format = Format.LOCALE, info = "Force the language (can be overwritten again with the env variable $LANG)")
	LANG, //
	@Meta(description = "reader type (CLI = simple output to console, TUI = Text User Interface with menus and windows, GUI = a GUI with locally stored files)", format = Format.FIXED_LIST, list = {
			"CLI", "GUI", "TUI" }, info = "Select the default reader to use to read stories")
	READER_TYPE, //
	@Meta(description = "absolute path, $HOME variable supported, / is always accepted as dir separator", format = Format.DIRECTORY, info = "The directory where to store temporary files, defaults to directory 'tmp' in the conig directory (usually $HOME/.fanfix)")
	CACHE_DIR, //
	@Meta(description = "delay in hours, or 0 for no cache, or -1 for infinite time (default)", format = Format.INT, info = "The delay after which a cached resource that is thought to change ~often is considered too old and triggers a refresh")
	CACHE_MAX_TIME_CHANGING, //
	@Meta(description = "delay in hours, or 0 for no cache, or -1 for infinite time (default)", format = Format.INT, info = "The delay after which a cached resource that is thought to change rarely is considered too old and triggers a refresh")
	CACHE_MAX_TIME_STABLE, //
	@Meta(description = "string", info = "The user-agent to use to download files")
	USER_AGENT, //
	@Meta(description = "absolute path, $HOME variable supported, / is always accepted as dir separator", format = Format.DIRECTORY, info = "The directory where to get the default story covers")
	DEFAULT_COVERS_DIR, //
	@Meta(description = "absolute path, $HOME variable supported, / is always accepted as dir separator", format = Format.DIRECTORY, info = "The directory where to store the library")
	LIBRARY_DIR, //
	@Meta(description = "boolean", format = Format.BOOLEAN, info = "Show debug information on errors")
	DEBUG_ERR, //
	@Meta(description = "image format", format = Format.COMBO_LIST, list = {
			"PNG", "JPG", "BMP" }, info = "Image format to use for cover images")
	IMAGE_FORMAT_COVER, //
	@Meta(description = "image format", format = Format.COMBO_LIST, list = {
			"PNG", "JPG", "BMP" }, info = "Image format to use for content images")
	IMAGE_FORMAT_CONTENT, //
	@Meta(group = true)
	LATEX_LANG, //
	@Meta(description = "LaTeX output language: English", info = "LaTeX full name")
	LATEX_LANG_EN, //
	@Meta(description = "LaTeX output language: French", info = "LaTeX full name")
	LATEX_LANG_FR, //
	@Meta(description = "other 'by' prefixes before author name, used to identify the author", array = true)
	BYS, //
	@Meta(description = "List of languages codes used for chapter identification (should not be changed)", array = true, info = "EN,FR")
	CHAPTER, //
	@Meta(description = "Chapter identification String: English", info = "used to identify a starting chapter in text mode")
	CHAPTER_EN, //
	@Meta(description = "Chapter identification String: French", info = "used to identify a starting chapter in text mode")
	CHAPTER_FR, //
	@Meta(description = "Login information (username) for YiffStar to have access to all the stories (should not be necessary anymore)")
	LOGIN_YIFFSTAR_USER, //
	@Meta(description = "Login information (password) for YiffStar to have access to all the stories (should not be necessary anymore)", format = Format.PASSWORD)
	LOGIN_YIFFSTAR_PASS, //
	@Meta(description = "If the last update check was done at least that many days, check for updates at startup (-1 for 'no checks' -- default is 1 day)", format = Format.INT)
	UPDATE_INTERVAL, //
	@Meta(description = "An API key required to create a token from FimFiction", format = Format.STRING)
	LOGIN_FIMFICTION_APIKEY_CLIENT_ID, //
	@Meta(description = "An API key required to create a token from FimFiction", format = Format.PASSWORD)
	LOGIN_FIMFICTION_APIKEY_CLIENT_SECRET, //
	@Meta(description = "Do not use the new API, even if we have a token, and force HTML scraping", format = Format.BOOLEAN)
	LOGIN_FIMFICTION_APIKEY_FORCE_HTML, //
	@Meta(description = "A token is required to use the beta APIv2 from FimFiction (see APIKEY_CLIENT_*)", format = Format.PASSWORD)
	LOGIN_FIMFICTION_APIKEY_TOKEN, //
}
Commit	Line	Data
08fe2e33 NR	1	package be.nikiroo.fanfix.bundles;
	2
	3	import be.nikiroo.utils.resources.Meta;
ce788468	4	import be.nikiroo.utils.resources.Meta.Format;
08fe2e33 NR	5
	6	/**
	7	* The configuration options.
	8	*
	9	* @author niki
	10	*/
ce788468	11	@SuppressWarnings("javadoc")
08fe2e33	12	public enum Config {
ce788468	13	@Meta(description = "language (example: en-GB, fr-BE...) or nothing for default system language", format = Format.LOCALE, info = "Force the language (can be overwritten again with the env variable $LANG)")
08fe2e33	14	LANG, //
c1873e56 NR	15	@Meta(description = "reader type (CLI = simple output to console, TUI = Text User Interface with menus and windows, GUI = a GUI with locally stored files)", format = Format.FIXED_LIST, list = {
c1873e56 NR	16	"CLI", "GUI", "TUI" }, info = "Select the default reader to use to read stories")
3727aae2	17	READER_TYPE, //
ce788468	18	@Meta(description = "absolute path, $HOME variable supported, / is always accepted as dir separator", format = Format.DIRECTORY, info = "The directory where to store temporary files, defaults to directory 'tmp' in the conig directory (usually $HOME/.fanfix)")
08fe2e33	19	CACHE_DIR, //
ce788468	20	@Meta(description = "delay in hours, or 0 for no cache, or -1 for infinite time (default)", format = Format.INT, info = "The delay after which a cached resource that is thought to change ~often is considered too old and triggers a refresh")
08fe2e33	21	CACHE_MAX_TIME_CHANGING, //
ce788468	22	@Meta(description = "delay in hours, or 0 for no cache, or -1 for infinite time (default)", format = Format.INT, info = "The delay after which a cached resource that is thought to change rarely is considered too old and triggers a refresh")
08fe2e33	23	CACHE_MAX_TIME_STABLE, //
ce788468	24	@Meta(description = "string", info = "The user-agent to use to download files")
08fe2e33	25	USER_AGENT, //
ce788468	26	@Meta(description = "absolute path, $HOME variable supported, / is always accepted as dir separator", format = Format.DIRECTORY, info = "The directory where to get the default story covers")
08fe2e33	27	DEFAULT_COVERS_DIR, //
ce788468	28	@Meta(description = "absolute path, $HOME variable supported, / is always accepted as dir separator", format = Format.DIRECTORY, info = "The directory where to store the library")
08fe2e33	29	LIBRARY_DIR, //
ce788468	30	@Meta(description = "boolean", format = Format.BOOLEAN, info = "Show debug information on errors")
08fe2e33	31	DEBUG_ERR, //
ce788468 NR	32	@Meta(description = "image format", format = Format.COMBO_LIST, list = {
ce788468 NR	33	"PNG", "JPG", "BMP" }, info = "Image format to use for cover images")
08fe2e33	34	IMAGE_FORMAT_COVER, //
ce788468 NR	35	@Meta(description = "image format", format = Format.COMBO_LIST, list = {
ce788468 NR	36	"PNG", "JPG", "BMP" }, info = "Image format to use for content images")
08fe2e33	37	IMAGE_FORMAT_CONTENT, //
ce788468	38	@Meta(group = true)
08fe2e33	39	LATEX_LANG, //
ce788468	40	@Meta(description = "LaTeX output language: English", info = "LaTeX full name")
08fe2e33	41	LATEX_LANG_EN, //
ce788468	42	@Meta(description = "LaTeX output language: French", info = "LaTeX full name")
08fe2e33	43	LATEX_LANG_FR, //
ce788468	44	@Meta(description = "other 'by' prefixes before author name, used to identify the author", array = true)
08fe2e33	45	BYS, //
ce788468	46	@Meta(description = "List of languages codes used for chapter identification (should not be changed)", array = true, info = "EN,FR")
08fe2e33	47	CHAPTER, //
ce788468	48	@Meta(description = "Chapter identification String: English", info = "used to identify a starting chapter in text mode")
08fe2e33	49	CHAPTER_EN, //
ce788468	50	@Meta(description = "Chapter identification String: French", info = "used to identify a starting chapter in text mode")
08fe2e33	51	CHAPTER_FR, //
ce788468	52	@Meta(description = "Login information (username) for YiffStar to have access to all the stories (should not be necessary anymore)")
6e06d2cc	53	LOGIN_YIFFSTAR_USER, //
ce788468	54	@Meta(description = "Login information (password) for YiffStar to have access to all the stories (should not be necessary anymore)", format = Format.PASSWORD)
6e06d2cc	55	LOGIN_YIFFSTAR_PASS, //
ce788468	56	@Meta(description = "If the last update check was done at least that many days, check for updates at startup (-1 for 'no checks' -- default is 1 day)", format = Format.INT)
315f14ae NR	57	UPDATE_INTERVAL, //
	58	@Meta(description = "An API key required to create a token from FimFiction", format = Format.STRING)
	59	LOGIN_FIMFICTION_APIKEY_CLIENT_ID, //
	60	@Meta(description = "An API key required to create a token from FimFiction", format = Format.PASSWORD)
	61	LOGIN_FIMFICTION_APIKEY_CLIENT_SECRET, //
	62	@Meta(description = "Do not use the new API, even if we have a token, and force HTML scraping", format = Format.BOOLEAN)
	63	LOGIN_FIMFICTION_APIKEY_FORCE_HTML, //
	64	@Meta(description = "A token is required to use the beta APIv2 from FimFiction (see APIKEY_CLIENT_*)", format = Format.PASSWORD)
	65	LOGIN_FIMFICTION_APIKEY_TOKEN, //
08fe2e33	66	}