dev.dejvokep.boostedyaml.settings.updater

Enum MergeRule

java.lang.Object

java.lang.Enum<MergeRule>

dev.dejvokep.boostedyaml.settings.updater.MergeRule

All Implemented Interfaces:

Serializable, Comparable<MergeRule>

public enum MergeRule
extends Enum<MergeRule>

Enum representing all situations during merging, used to specify rules.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MAPPING_AT_SECTION Represents a situation where block at a certain route in: document is a mapping defaults is a section This situation is, during merging, also referred to as mapping at section.
MAPPINGS Represents a situation where block at a certain route is a mapping in both the document and defaults.
SECTION_AT_MAPPING Represents a situation where block at a certain route in: document is a section defaults is a mapping This situation is, during merging, also referred to as section at mapping.

Method Summary

Modifier and Type	Method and Description
static MergeRule	getFor(boolean documentBlockIsSection, boolean defaultBlockIsSection) Returns merge rule representing the given information.
static MergeRule	valueOf(String name) Returns the enum constant of this type with the specified name.
static MergeRule[]	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

SECTION_AT_MAPPING

public static final MergeRule SECTION_AT_MAPPING

Represents a situation where block at a certain route in:

• document is a section
• defaults is a mapping

This situation is, during merging, also referred to as section at mapping.

MAPPING_AT_SECTION

public static final MergeRule MAPPING_AT_SECTION

Represents a situation where block at a certain route in:

• document is a mapping
• defaults is a section

This situation is, during merging, also referred to as mapping at section.

MAPPINGS

public static final MergeRule MAPPINGS

Represents a situation where block at a certain route is a mapping in both the document and defaults.

This situation is, during merging, also referred to as mapping at mapping.

Method Detail

values

public static MergeRule[] 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 (MergeRule c : MergeRule.values())
    System.out.println(c);

Returns:

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

valueOf

public static MergeRule 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

getFor

public static MergeRule getFor(boolean documentBlockIsSection,
                               boolean defaultBlockIsSection)

Returns merge rule representing the given information.

Parameters:

documentBlockIsSection - if the document block is a section

defaultBlockIsSection - if the default block is a section

Returns:

the merge rule