B

bool(String, String, Enum, String) - Static method in class com.headius.options.Option

Create a new Boolean option with the given configuration.

bool(String, Enum, String) - Static method in class com.headius.options.Option

Create a new Boolean option with the given configuration.

bool(String, String, Enum, Boolean, String) - Static method in class com.headius.options.Option

Create a new Boolean option with the given configuration.

bool(String, Enum, Boolean, String) - Static method in class com.headius.options.Option

Create a new Boolean option with the given configuration.

BooleanOption - Class in com.headius.options

A Boolean-based Option.

BooleanOption(String, String, Enum, Boolean, String) - Constructor for class com.headius.options.BooleanOption

 

BooleanOption(String, Enum, Boolean, String) - Constructor for class com.headius.options.BooleanOption

 

C

com.headius.options - package com.headius.options

 

com.headius.options.example - package com.headius.options.example

 

D

defaultValue() - Method in class com.headius.options.Option

The default value for the option, or null if no default is provided.

defval - Variable in class com.headius.options.Option

 

description() - Method in class com.headius.options.Option

The long description of the property, as for documentation and configuration file templates.

displayName() - Method in class com.headius.options.Option

The display name of the option's property, either the short name or the full name.

E

enumeration(String, String, Enum, Class<T>, String) - Static method in class com.headius.options.Option

Create a new Enumeration-based option with the given configuration.

enumeration(String, Enum, Class<T>, String) - Static method in class com.headius.options.Option

Create a new Enumeration-based option with the given configuration.

enumeration(String, String, Enum, T, String) - Static method in class com.headius.options.Option

Create a new Enumeration-based option with the given configuration.

enumeration(String, Enum, T, String) - Static method in class com.headius.options.Option

Create a new Enumeration-based option with the given configuration.

EnumerationOption<T extends Enum<T>> - Class in com.headius.options

An Enum-based Option.

EnumerationOption(String, String, Enum, Class<T>, T, String) - Constructor for class com.headius.options.EnumerationOption

 

EnumerationOption(String, Enum, Class<T>, T, String) - Constructor for class com.headius.options.EnumerationOption

 

Example - Class in com.headius.options.example

An example of Option usage.

Example() - Constructor for class com.headius.options.example.Example

 

F

force(String) - Method in class com.headius.options.Option

Force the property value to the given value for all future loads and reloads.

formatOptions(Option...) - Static method in class com.headius.options.Option

Format the given options in a way suitable for use as a configuration file or documentation.

formatOptions(Collection<Option>) - Static method in class com.headius.options.Option

Format the given options in a way suitable for use as a configuration file or documentation.

formatValues(Option...) - Static method in class com.headius.options.Option

Format the given options to show their loaded values in the current JVM.

formatValues(Collection<Option>) - Static method in class com.headius.options.Option

Format the given options to show their loaded values in the current JVM.

I

integer(String, String, Enum, String) - Static method in class com.headius.options.Option

Create a new Integer option with the given configuration.

integer(String, String, Enum, Integer[], String) - Static method in class com.headius.options.Option

Create a new Integer option with the given configuration.

integer(String, Enum, String) - Static method in class com.headius.options.Option

Create a new Integer option with the given configuration.

integer(String, Enum, Integer[], String) - Static method in class com.headius.options.Option

Create a new Integer option with the given configuration.

integer(String, String, Enum, Integer, String) - Static method in class com.headius.options.Option

Create a new Integer option with the given configuration.

integer(String, Enum, Integer, String) - Static method in class com.headius.options.Option

Create a new Integer option with the given configuration.

integer(String, String, Enum, Integer[], Integer, String) - Static method in class com.headius.options.Option

Create a new Integer option with the given configuration.

integer(String, Enum, Integer[], Integer, String) - Static method in class com.headius.options.Option

Create a new Integer option with the given configuration.

IntegerOption - Class in com.headius.options

An Integer-based Option.

IntegerOption(String, String, Enum, Integer[], Integer, String) - Constructor for class com.headius.options.IntegerOption

 

IntegerOption(String, Enum, Integer[], Integer, String) - Constructor for class com.headius.options.IntegerOption

 

IntegerOption(String, String, Enum, Integer, String) - Constructor for class com.headius.options.IntegerOption

 

IntegerOption(String, Enum, Integer, String) - Constructor for class com.headius.options.IntegerOption

 

isSpecified() - Method in class com.headius.options.Option

Return true if the option's property was specified, false otherwise.

L

load() - Method in class com.headius.options.Option

Return the value of the option, loading if it has not been already.

loadProperty() - Method in class com.headius.options.Option

Load the option's property, as if by calling java.lang.System#getProperty

M

main(String[]) - Static method in class com.headius.options.example.Example

 

O

Option<T> - Class in com.headius.options

Represents a single option, with a category, name, value type, options, default value, and description.

Option(String, String, Class<T>, Enum, T[], T, String) - Constructor for class com.headius.options.Option

Create a new option with the given values.

Option(String, Class<T>, Enum, T[], T, String) - Constructor for class com.headius.options.Option

Create a new option with the given values.

options() - Method in class com.headius.options.Option

The array of accepted values for the option, or null if any values are accepted.

P

prefix() - Method in class com.headius.options.Option

If the property has a prefix, return it.

propertyName() - Method in class com.headius.options.Option

Return the full property name for the option.

R

reload() - Method in class com.headius.options.Option

Force a load of the option's property and return the loaded value.

reloadValue() - Method in class com.headius.options.BooleanOption

 

reloadValue() - Method in class com.headius.options.EnumerationOption

 

reloadValue() - Method in class com.headius.options.IntegerOption

 

reloadValue() - Method in class com.headius.options.Option

Perform the appropriate load and conversion for the option's property.

reloadValue() - Method in class com.headius.options.StringOption

 

S

shortName() - Method in class com.headius.options.Option

If the option has a short name, return it.

string(String, String, Enum, String) - Static method in class com.headius.options.Option

Create a new String option with the given configuration.

string(String, Enum, String) - Static method in class com.headius.options.Option

Create a new String option with the given configuration.

string(String, String, Enum, String, String) - Static method in class com.headius.options.Option

Create a new String option with the given configuration.

string(String, Enum, String, String) - Static method in class com.headius.options.Option

Create a new String option with the given configuration.

string(String, String, Enum, String[], String) - Static method in class com.headius.options.Option

Create a new String option with the given configuration.

string(String, Enum, String[], String) - Static method in class com.headius.options.Option

Create a new String option with the given configuration.

string(String, String, Enum, String[], String, String) - Static method in class com.headius.options.Option

Create a new String option with the given configuration.

string(String, Enum, String[], String, String) - Static method in class com.headius.options.Option

Create a new String option with the given configuration.

StringOption - Class in com.headius.options

A String-based Option.

StringOption(String, String, Enum, String[], String, String) - Constructor for class com.headius.options.StringOption

 

StringOption(String, Enum, String[], String, String) - Constructor for class com.headius.options.StringOption

 

T

toString() - Method in class com.headius.options.Option

 

type - Variable in class com.headius.options.Option

 

type() - Method in class com.headius.options.Option

The type returned for the option.

U

unforce() - Method in class com.headius.options.Option

Undoes any previous force, and goes back to an unloaded state.