dev.dejvokep.boostedyaml.settings.updater

Enum UpdaterSettings.OptionSorting

java.lang.Object

java.lang.Enum<UpdaterSettings.OptionSorting>

dev.dejvokep.boostedyaml.settings.updater.UpdaterSettings.OptionSorting

All Implemented Interfaces:

Serializable, Comparable<UpdaterSettings.OptionSorting>

Enclosing class:

UpdaterSettings

public static enum UpdaterSettings.OptionSorting
extends Enum<UpdaterSettings.OptionSorting>

Enum defining how options in sections should be sorted during merging.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONE Does not sort.
SORT_BY_DEFAULTS Sorts options by their order in the defaults.

Method Summary

Modifier and Type	Method and Description
static UpdaterSettings.OptionSorting	valueOf(String name) Returns the enum constant of this type with the specified name.
static UpdaterSettings.OptionSorting[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final UpdaterSettings.OptionSorting NONE

Does not sort. This setting ensures that new entries from the defaults will be placed as the last into the section map.

This setting does not introduce any additional memory consumption and should be used if the map implementation defined by GeneralSettings.Builder#setDefaultMap(MapSupplier) doesn't preserve element order (for example HashMap).

SORT_BY_DEFAULTS

public static final UpdaterSettings.OptionSorting SORT_BY_DEFAULTS

Sorts options by their order in the defaults. This setting ensures that entries which will appear in the merged document will be placed into the section map in order defined by the defaults.

Note that the order depends on the map implementation defined by GeneralSettings.Builder#setDefaultMap(MapSupplier). If the used implementation does not preserve order of the elements (as they were put into the map), avoid additional memory consumption and use NONE instead.

Method Detail

values

public static UpdaterSettings.OptionSorting[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (UpdaterSettings.OptionSorting c : UpdaterSettings.OptionSorting.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static UpdaterSettings.OptionSorting valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null