Package com.github.copilot.sdk

Enum Class SystemMessageMode

java.lang.Object

java.lang.Enum<SystemMessageMode>

com.github.copilot.sdk.SystemMessageMode

All Implemented Interfaces:

Serializable, Comparable<SystemMessageMode>, Constable

public enum SystemMessageMode
extends Enum<SystemMessageMode>

Specifies how the system message should be applied to a session.

The system message controls the behavior and personality of the AI assistant. This enum determines whether to append custom instructions to the default system message or replace it entirely.

Since:

1.0.0

See Also:

• SystemMessageConfig

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
APPEND	Append the custom content to the default system message.
REPLACE	Replace the default system message entirely with the custom content.

Method Summary

Modifier and Type	Method	Description
String	getValue()	Returns the JSON value for this mode.
static SystemMessageMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SystemMessageMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

APPEND

public static final SystemMessageMode APPEND

Append the custom content to the default system message.

This mode preserves the default guardrails and behaviors while adding additional instructions or context.

REPLACE

public static final SystemMessageMode REPLACE

Replace the default system message entirely with the custom content.

Warning: This mode removes all default guardrails and behaviors. Use with caution.

Method Details

values

public static SystemMessageMode[] 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 SystemMessageMode 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

getValue

public String getValue()

Returns the JSON value for this mode.

Returns:

the string value used in JSON serialization