meldexun.betterconfig.api

Annotation Type BetterConfig

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface BetterConfig

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	modid

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	addDefaultsToComments
boolean	addRangesToComments
boolean	bigCategoryComments
java.lang.String	category
BetterConfig.ConfigComparator[]	elementOrder Defines the ordering for elements in this configuration.
boolean	lowerCaseCategories
java.lang.String	name
boolean	removeDeprecatedEntries

Element Detail

modid

public abstract java.lang.String modid

name

public abstract java.lang.String name

Default:

""

category

public abstract java.lang.String category

Default:

"general"

lowerCaseCategories

public abstract boolean lowerCaseCategories

Default:

true

bigCategoryComments

public abstract boolean bigCategoryComments

Default:

true

addRangesToComments

public abstract boolean addRangesToComments

Default:

true

addDefaultsToComments

public abstract boolean addDefaultsToComments

Default:

true

removeDeprecatedEntries

public abstract boolean removeDeprecatedEntries

Default:

false

elementOrder

public abstract BetterConfig.ConfigComparator[] elementOrder

Defines the ordering for elements in this configuration.

Comparators are applied sequentially. If a comparator considers two elements equal, the next comparator is used to determine the order.

Possible values:

• EXPLICIT – Orders elements by the value of their @Order annotation.
• CATEGORIES_FIRST – Category elements come first.
• CATEGORIES_LAST – Category elements come last.
• NON_MAP_CATEGORIES_FIRST – Non-map-category elements come first.
• NON_MAP_CATEGORIES_LAST – Non-map-category elements come last.
• NAME_CASE_SENSITIVE – Orders elements by comparing their name lexicographically, case-sensitively.
• NAME_CASE_INSENSITIVE – Orders elements by comparing their name lexicographically, ignoring case.
• INITIALIZATION – WARNING, READ CAREFULLY! Attempts to order elements by their initialization order. The JVM does not provide a guaranteed way to retrieve field initialization order at runtime. BetterConfig analyzes the class bytecode to approximate this order. While this works in most cases, correctness and stability are not guaranteed.

Default:

{meldexun.betterconfig.api.BetterConfig.ConfigComparator.EXPLICIT, meldexun.betterconfig.api.BetterConfig.ConfigComparator.CATEGORIES_LAST, meldexun.betterconfig.api.BetterConfig.ConfigComparator.NAME_CASE_SENSITIVE}