net.neoforged.jarcompatibilitychecker

Class JarCompatibilityChecker

java.lang.Object

net.neoforged.jarcompatibilitychecker.JarCompatibilityChecker

public class JarCompatibilityChecker
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
JarCompatibilityChecker(java.io.File baseJar, java.io.File inputJar, boolean checkBinary, @Nullable AnnotationCheckMode annotationCheckMode, java.util.List<java.io.File> commonLibs, java.util.List<java.io.File> baseLibs, java.util.List<java.io.File> concreteLibs, java.util.function.Consumer<java.lang.String> stdLogger, java.util.function.Consumer<java.lang.String> errLogger) Constructs a new JarCompatibilityChecker.
JarCompatibilityChecker(java.io.File baseJar, java.io.File inputJar, boolean checkBinary, @Nullable AnnotationCheckMode annotationCheckMode, java.util.List<java.lang.String> internalAnnotations, InternalAnnotationCheckMode internalAnnotationCheckMode, java.util.List<java.io.File> commonLibs, java.util.List<java.io.File> baseLibs, java.util.List<java.io.File> concreteLibs, java.util.function.Consumer<java.lang.String> stdLogger, java.util.function.Consumer<java.lang.String> errLogger) Constructs a new JarCompatibilityChecker.
JarCompatibilityChecker(java.io.File baseJar, java.io.File inputJar, boolean checkBinary, java.util.List<java.io.File> commonLibs, java.util.List<java.io.File> baseLibs, java.util.List<java.io.File> concreteLibs, java.util.function.Consumer<java.lang.String> stdLogger, java.util.function.Consumer<java.lang.String> errLogger) Constructs a new JarCompatibilityChecker.

Method Summary

Modifier and Type	Method and Description
java.util.Map.Entry<java.lang.Integer,java.util.List<ClassInfoComparisonResults>>	check() Loads the base jar and input jar and compares them for compatibility based on the current mode, API or binary.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JarCompatibilityChecker

public JarCompatibilityChecker(java.io.File baseJar,
                               java.io.File inputJar,
                               boolean checkBinary,
                               java.util.List<java.io.File> commonLibs,
                               java.util.List<java.io.File> baseLibs,
                               java.util.List<java.io.File> concreteLibs,
                               java.util.function.Consumer<java.lang.String> stdLogger,
                               java.util.function.Consumer<java.lang.String> errLogger)

Constructs a new JarCompatibilityChecker.

Parameters:

checkBinary - if true, all members of the base jar including package-private and private will be checked for a match in the input jar. Otherwise, only public and protected members of the base jar will be checked for a match in the input jar.

JarCompatibilityChecker

public JarCompatibilityChecker(java.io.File baseJar,
                               java.io.File inputJar,
                               boolean checkBinary,
                               @Nullable
                               @Nullable AnnotationCheckMode annotationCheckMode,
                               java.util.List<java.io.File> commonLibs,
                               java.util.List<java.io.File> baseLibs,
                               java.util.List<java.io.File> concreteLibs,
                               java.util.function.Consumer<java.lang.String> stdLogger,
                               java.util.function.Consumer<java.lang.String> errLogger)

Constructs a new JarCompatibilityChecker.

Parameters:

checkBinary - if true, all members of the base jar including package-private and private will be checked for a match in the input jar. Otherwise, only public and protected members of the base jar will be checked for a match in the input jar.

annotationCheckMode - determines whether annotations will be checked and if a mismatch is an error condition

JarCompatibilityChecker

public JarCompatibilityChecker(java.io.File baseJar,
                               java.io.File inputJar,
                               boolean checkBinary,
                               @Nullable
                               @Nullable AnnotationCheckMode annotationCheckMode,
                               java.util.List<java.lang.String> internalAnnotations,
                               InternalAnnotationCheckMode internalAnnotationCheckMode,
                               java.util.List<java.io.File> commonLibs,
                               java.util.List<java.io.File> baseLibs,
                               java.util.List<java.io.File> concreteLibs,
                               java.util.function.Consumer<java.lang.String> stdLogger,
                               java.util.function.Consumer<java.lang.String> errLogger)

Constructs a new JarCompatibilityChecker.

Parameters:

checkBinary - if true, all members of the base jar including package-private and private will be checked for a match in the input jar. Otherwise, only public and protected members of the base jar will be checked for a match in the input jar.

annotationCheckMode - determines whether annotations will be checked and if a mismatch is an error condition

internalAnnotations - a list of fully resolved classnames for annotations that can be used to mark elements as internal API

internalAnnotationCheckMode - determines how internally-marked elements will be checked

Method Detail

check

public java.util.Map.Entry<java.lang.Integer,java.util.List<ClassInfoComparisonResults>> check()
                                                                                        throws java.io.IOException

Loads the base jar and input jar and compares them for compatibility based on the current mode, API or binary. Any incompatibilities will be logged to the error logger.

Returns:

the number of incompatibilities detected based on the current mode, and the incompatibilities

Throws:

java.io.IOException