Enum Class CodeMergeStrategy

java.lang.Object

java.lang.Enum<CodeMergeStrategy>

io.github.mmm.code.api.merge.CodeMergeStrategy

All Implemented Interfaces:

Serializable, Comparable<CodeMergeStrategy>, Constable

public enum CodeMergeStrategy
extends Enum<CodeMergeStrategy>

Enum with the available strategies for a merge.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
KEEP	Keeps the original item (on which merge was invoked) untouched.
MERGE_KEEP_BODY	Merges the signature(s) of both elements items (joins annotations, docs, and comments) but keeps the original body or initializer (CodeField.getInitializer() or CodeBlockInitializer).
MERGE_OVERRIDE_BODY	Merges the signature(s) of both elements items (joins annotations, docs, and comments) but overrides the original body or initializer (CodeField.getInitializer() or CodeBlockInitializer).
OVERRIDE	Overrides the original item (on which merge was invoked) with the one given as merge argument.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OVERRIDE

public static final CodeMergeStrategy OVERRIDE

Overrides the original item (on which merge was invoked) with the one given as merge argument.

KEEP

public static final CodeMergeStrategy KEEP

Keeps the original item (on which merge was invoked) untouched. In other words the merge does nothing.

MERGE_OVERRIDE_BODY

public static final CodeMergeStrategy MERGE_OVERRIDE_BODY

Merges the signature(s) of both elements items (joins annotations, docs, and comments) but overrides the original body or initializer (CodeField.getInitializer() or CodeBlockInitializer).

MERGE_KEEP_BODY

public static final CodeMergeStrategy MERGE_KEEP_BODY

Merges the signature(s) of both elements items (joins annotations, docs, and comments) but keeps the original body or initializer (CodeField.getInitializer() or CodeBlockInitializer).

Method Details

values

public static CodeMergeStrategy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static CodeMergeStrategy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

isMerge

public boolean isMerge()

Returns:

true if MERGE_OVERRIDE_BODY or MERGE_KEEP_BODY, false otherwise. Please note that a merge will only behave different between MERGE_OVERRIDE_BODY and MERGE_KEEP_BODY for items that do have a body (in other words CodeFunctions) or initializer (in other words (CodeFields or (CodeTypes).