All Implemented Interfaces:


public class LoadOptions.Companion

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final LoadOptions`	`DEFAULT`
`private final Sequence<Field>`	`optionFields`
`private final Map<String, Field>`	`optionFieldsMap`
`private final Map<String, Object>`	`defaultParams`
`private final Map<String, String>`	`defaultArgsMap`
`private final List<String>`	`arity0BooleanParams`
`private final List<String>`	`arity1BooleanParams`
`private final List<String>`	`optionNames`
`private final List<String>`	`apiPublicOptionNames`
`private final List<List<String>>`	`helpList`
`public final static LoadOptions.Companion`	`INSTANCE`

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Unit`	`setFieldByAnnotation(LoadOptions options, String annotationName, Object value)`	Sets the value of a field based on its annotation name.
`final List<String>`	`getOptionNames(String fieldName)`	Returns all option names for a given field.
`final LoadOptions`	`create(VolatileConfig conf)`	Creates a new empty LoadOptions with the given configuration.
`final LoadOptions`	`createUnsafe()`	Creates a new empty LoadOptions with an unsafe configuration.
`final String`	`normalize(String args)`	Normalizes arguments into a standard format.
`final LoadOptions`	`parse(String args, VolatileConfig conf)`	Parses a string of arguments into a LoadOptions object.
`final LoadOptions`	`parse(String args, LoadOptions options)`	Parses a string of arguments into a LoadOptions object based on another instance.
`final LoadOptions`	`merge(LoadOptions o1, LoadOptions o2)`	Merges two LoadOptions objects, with o2 options taking precedence.
`final LoadOptions`	`merge(LoadOptions o1, String args)`	Merges a LoadOptions object with additional arguments string.
`final LoadOptions`	`merge(String args, String args2, VolatileConfig conf)`	Merges two argument strings into a single LoadOptions.
`final String`	`mergeArgs(String args, VolatileConfig conf)`	Merges multiple argument strings, with later arguments taking precedence.
`final String`	`eraseOptions(String args, String fieldNames)`	Removes specified options from an arguments string.
`final LoadOptions`	`getDEFAULT()`	Default LoadOptions instance with standard settings.
`final Sequence<Field>`	`getOptionFields()`	List of all option fields in the LoadOptions class.
`final Map<String, Field>`	`getOptionFieldsMap()`	Map of field names to their corresponding Field objects.
`final Map<String, Object>`	`getDefaultParams()`	Map of field names to their default values from DEFAULT instance.
`final Map<String, String>`	`getDefaultArgsMap()`	Map of default option names and values.
`final List<String>`	`getArity0BooleanParams()`	List of zero-arity boolean parameter names.
`final List<String>`	`getArity1BooleanParams()`	List of single-arity boolean parameter names.
`final List<String>`	`getOptionNames()`	List of all option names from parameter annotations.
`final List<String>`	`getApiPublicOptionNames()`	List of option names that are marked as API public.
`final List<List<String>>`	`getHelpList()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - setFieldByAnnotation
```
 final Unit setFieldByAnnotation(LoadOptions options, String annotationName, Object value)
```
    Sets the value of a field based on its annotation name.
    
    Parameters:
    
    options - the LoadOptions instance to modify
    
    annotationName - the annotation name to search for
    
    value - the value to set
  - getOptionNames
```
 final List<String> getOptionNames(String fieldName)
```
    Returns all option names for a given field.
    
    Parameters:
    
    fieldName - the field name to look up
    
    Returns:
    
    list of all option names for that field
  - create
```
 final LoadOptions create(VolatileConfig conf)
```
    Creates a new empty LoadOptions with the given configuration.
    
    Parameters:
    
    conf - the configuration to use
    
    Returns:
    
    a new LoadOptions instance
  - createUnsafe
```
 final LoadOptions createUnsafe()
```
    Creates a new empty LoadOptions with an unsafe configuration.
    
    Returns:
    
    a new LoadOptions instance
  - normalize
```
 final String normalize(String args)
```
    Normalizes arguments into a standard format.
    
    Parameters:
    
    args - the arguments to normalize
    
    Returns:
    
    normalized arguments string
  - parse
```
 final LoadOptions parse(String args, VolatileConfig conf)
```
    Parses a string of arguments into a LoadOptions object.
    
    Parameters:
    
    args - the arguments string to parse
    
    conf - the configuration to use
    
    Returns:
    
    the parsed LoadOptions
  - parse
```
 final LoadOptions parse(String args, LoadOptions options)
```
    Parses a string of arguments into a LoadOptions object based on another instance.
    
    Parameters:
    
    args - the arguments string to parse
    
    options - the base options to use
    
    Returns:
    
    the parsed LoadOptions
  - merge
```
 final LoadOptions merge(LoadOptions o1, LoadOptions o2)
```
    Merges two LoadOptions objects, with o2 options taking precedence.
    
    Parameters:
    
    o1 - the base options
    
    o2 - the overriding options
    
    Returns:
    
    a new merged LoadOptions
  - merge
```
 final LoadOptions merge(LoadOptions o1, String args)
```
    Merges a LoadOptions object with additional arguments string.
    
    Parameters:
    
    o1 - the base options
    
    args - the overriding arguments
    
    Returns:
    
    a new merged LoadOptions
  - merge
```
 final LoadOptions merge(String args, String args2, VolatileConfig conf)
```
    Merges two argument strings into a single LoadOptions.
    
    Parameters:
    
    args - the base arguments
    
    args2 - the overriding arguments
    
    conf - the configuration to use
    
    Returns:
    
    a new merged LoadOptions
  - mergeArgs
```
 final String mergeArgs(String args, VolatileConfig conf)
```
    Merges multiple argument strings, with later arguments taking precedence.
    
    Parameters:
    
    args - the argument strings to merge
    
    conf - the configuration to use
    
    Returns:
    
    the merged arguments string
  - eraseOptions
```
 final String eraseOptions(String args, String fieldNames)
```
    Removes specified options from an arguments string.
    
    Parameters:
    
    args - the original arguments string
    
    fieldNames - the field names to remove
    
    Returns:
    
    the modified arguments string
  - getDEFAULT
```
 final LoadOptions getDEFAULT()
```
    Default LoadOptions instance with standard settings. Used as a base for comparison and default values.
  - getOptionFields
```
 final Sequence<Field> getOptionFields()
```
    List of all option fields in the LoadOptions class. Contains fields with Parameter annotations for option parsing.
  - getOptionFieldsMap
```
 final Map<String, Field> getOptionFieldsMap()
```
    Map of field names to their corresponding Field objects.
  - getDefaultParams
```
 final Map<String, Object> getDefaultParams()
```
    Map of field names to their default values from DEFAULT instance.
  - getDefaultArgsMap
```
 final Map<String, String> getDefaultArgsMap()
```
    Map of default option names and values.
  - getArity0BooleanParams
```
 final List<String> getArity0BooleanParams()
```
    List of zero-arity boolean parameter names. These are parameters that don't require a value (flag parameters).
  - getArity1BooleanParams
```
 final List<String> getArity1BooleanParams()
```
    List of single-arity boolean parameter names. These are boolean parameters that require a value.
  - getOptionNames
```
 final List<String> getOptionNames()
```
    List of all option names from parameter annotations.
  - getApiPublicOptionNames
```
 final List<String> getApiPublicOptionNames()
```
    List of option names that are marked as API public. These options are exposed through REST APIs.
  - getHelpList
```
 final List<List<String>> getHelpList()
```

Object LoadOptions.Companion

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

setFieldByAnnotation

getOptionNames

create

createUnsafe

normalize

parse

parse

merge

merge

merge

mergeArgs

eraseOptions

getDEFAULT

getOptionFields

getOptionFieldsMap

getDefaultParams

getDefaultArgsMap

getArity0BooleanParams

getArity1BooleanParams

getOptionNames

getApiPublicOptionNames

getHelpList