net.neoforged.jarcompatibilitychecker.core

Enum InternalAnnotationCheckMode

java.lang.Object

java.lang.Enum<InternalAnnotationCheckMode>

net.neoforged.jarcompatibilitychecker.core.InternalAnnotationCheckMode

All Implemented Interfaces:

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

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

This enum determines the check mode for all elements marked with internal annotations. An internal annotation can be used to mark an element as internal API, meaning binary breaking changes are allowed for that element. Note that adding an internal annotation to an element while changing it is still considered a binary breaking change.

By default, the WARN mode is used.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERROR Error-level incompatibilities will be raised for elements regardless of being marked with an internal annotation.
SKIP No checks will be performed on elements annotated with an internal annotation.
WARN All error-level incompatibilities will be lowered to warnings for elements annotated with an internal annotation.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List<java.lang.String>	DEFAULT_INTERNAL_ANNOTATIONS
static InternalAnnotationCheckMode	DEFAULT_MODE

Method Summary

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

No checks will be performed on elements annotated with an internal annotation.

WARN

public static final InternalAnnotationCheckMode WARN

All error-level incompatibilities will be lowered to warnings for elements annotated with an internal annotation.

ERROR

public static final InternalAnnotationCheckMode ERROR

Error-level incompatibilities will be raised for elements regardless of being marked with an internal annotation.

Field Detail

DEFAULT_MODE

public static final InternalAnnotationCheckMode DEFAULT_MODE

DEFAULT_INTERNAL_ANNOTATIONS

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

Method Detail

values

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

Returns:

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

valueOf

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