net.neoforged.jarcompatibilitychecker.core

Enum NonExtendableApiCheckMode

java.lang.Object

java.lang.Enum<NonExtendableApiCheckMode>

net.neoforged.jarcompatibilitychecker.core.NonExtendableApiCheckMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NonExtendableApiCheckMode>

public enum NonExtendableApiCheckMode
extends java.lang.Enum<NonExtendableApiCheckMode>

This enum determines the check mode for extension-only incompatibilities on elements marked with non-extendable API annotations. A non-extendable API annotation can be used to mark a public API element as unsupported for external implementation, subclassing, or overriding.

By default, the WARN mode is used so extension-only incompatibilities are reported without failing compatibility checks.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERROR Error-level incompatibilities will be raised regardless of being marked with a non-extendable API annotation.
SKIP No extension-only incompatibilities will be reported for elements annotated with a non-extendable API annotation.
WARN Extension-only incompatibilities will be lowered to warnings for elements annotated with a non-extendable API annotation.

Field Summary

Fields

Modifier and Type	Field and Description
static NonExtendableApiCheckMode	DEFAULT_MODE
static java.util.List<java.lang.String>	DEFAULT_NON_EXTENDABLE_API_ANNOTATIONS

Method Summary

Modifier and Type	Method and Description
static NonExtendableApiCheckMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static NonExtendableApiCheckMode[]	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

SKIP

public static final NonExtendableApiCheckMode SKIP

No extension-only incompatibilities will be reported for elements annotated with a non-extendable API annotation.

WARN

public static final NonExtendableApiCheckMode WARN

Extension-only incompatibilities will be lowered to warnings for elements annotated with a non-extendable API annotation.

ERROR

public static final NonExtendableApiCheckMode ERROR

Error-level incompatibilities will be raised regardless of being marked with a non-extendable API annotation.

Field Detail

DEFAULT_MODE

public static final NonExtendableApiCheckMode DEFAULT_MODE

DEFAULT_NON_EXTENDABLE_API_ANNOTATIONS

public static final java.util.List<java.lang.String> DEFAULT_NON_EXTENDABLE_API_ANNOTATIONS

Method Detail

values

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

Returns:

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

valueOf

public static NonExtendableApiCheckMode valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null