Package jline.api.sn

Enum ModifyMode

java.lang.Object

java.lang.Enum<ModifyMode>

jline.api.sn.ModifyMode

All Implemented Interfaces:

Serializable, Comparable<ModifyMode>, java.lang.constant.Constable

public enum ModifyMode
extends Enum<ModifyMode>

Modification mode for SN setter methods. Controls whether modifications are made in-place on the input NetworkStruct or on a copy that is returned.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COPY	Create a deep copy of the NetworkStruct, modify the copy, and return it.
IN_PLACE	Modify the input NetworkStruct in place and return it.

Method Summary

Modifier and Type	Method	Description
static ModifyMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ModifyMode[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

IN_PLACE

public static final ModifyMode IN_PLACE

Modify the input NetworkStruct in place and return it. This is the fastest option, suitable for optimization loops.

COPY

public static final ModifyMode COPY

Create a deep copy of the NetworkStruct, modify the copy, and return it. The original NetworkStruct remains unchanged. Useful when you need to preserve the original state.

Method Details

values

public static ModifyMode[] values()

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

Returns:

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

valueOf

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