net.neoforged.jarcompatibilitychecker.core

Class ClassInfoComparer

java.lang.Object

net.neoforged.jarcompatibilitychecker.core.ClassInfoComparer

public class ClassInfoComparer
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ClassInfoComparer()

Method Summary

Modifier and Type	Method and Description
static <I extends MemberInfo> void	checkAnnotations(@Nullable AnnotationCheckMode mode, ClassInfoComparisonResults results, I memberInfo, boolean isError, java.util.List<AnnotationInfo> baseAnnotations, java.util.List<AnnotationInfo> concreteAnnotations)
static <I extends MemberInfo> void	checkAnnotations(@Nullable AnnotationCheckMode mode, ClassInfoComparisonResults results, I memberInfo, java.util.List<AnnotationInfo> baseAnnotations, java.util.List<AnnotationInfo> concreteAnnotations)
static ClassInfoComparisonResults	compare(boolean checkBinary, @Nullable AnnotationCheckMode annotationCheckMode, ClassInfoCache baseCache, ClassInfo baseClassInfo, ClassInfoCache concreteCache, @Nullable ClassInfo concreteClassInfo)
static ClassInfoComparisonResults	compare(boolean checkBinary, @Nullable AnnotationCheckMode annotationCheckMode, java.util.List<java.lang.String> internalAnnotations, InternalAnnotationCheckMode internalAnnotationCheckMode, ClassInfoCache baseCache, ClassInfo baseClassInfo, ClassInfoCache concreteCache, @Nullable ClassInfo concreteClassInfo)
static ClassInfoComparisonResults	compare(boolean checkBinary, ClassInfoCache baseCache, ClassInfo baseClassInfo, ClassInfoCache concreteCache, @Nullable ClassInfo concreteClassInfo)
static @Nullable FieldInfo	getFieldInfo(ClassInfo classInfo, java.util.List<ClassInfo> parents, boolean isStatic, java.lang.String fieldName)
static @Nullable MethodInfo	getMethodInfo(ClassInfo classInfo, java.util.List<ClassInfo> parents, boolean isStatic, java.lang.String methodName, java.lang.String methodDesc)
static java.util.List<ClassInfo>	getParentClassInfos(boolean checkBinary, ClassInfoCache cache, ClassInfo classInfo, boolean includeSuper) Returns a list of parent class infos, both super classes and interfaces.
static java.util.List<java.lang.String>	getParentClassNames(boolean checkBinary, ClassInfoCache cache, ClassInfo classInfo, boolean includeSuper) Returns a list of parent class names, both super classes and interfaces.
static boolean	hasSuperClass(ClassInfoCache cache, ClassInfo classInfo, java.lang.String superClass)
static boolean	isInternalApi(MemberInfo memberInfo, java.util.List<java.lang.String> internalAnnotations, InternalAnnotationCheckMode checkMode)
static boolean	isInternalApi(MemberInfo memberInfo, java.util.List<java.lang.String> internalAnnotations, InternalAnnotationCheckMode checkMode, @Nullable ClassInfo packageInfo)
static boolean	isMadeAbstract(boolean classVisible, int baseAccess, int inputAccess)
static boolean	isMadeFinal(boolean checkBinary, int baseAccess, int inputAccess)
static boolean	isVisibilityLowered(boolean checkBinary, int baseAccess, int inputAccess)
static boolean	isVisible(boolean checkBinary, int access)

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassInfoComparer

public ClassInfoComparer()

Method Detail

compare

public static ClassInfoComparisonResults compare(boolean checkBinary,
                                                 ClassInfoCache baseCache,
                                                 ClassInfo baseClassInfo,
                                                 ClassInfoCache concreteCache,
                                                 @Nullable
                                                 @Nullable ClassInfo concreteClassInfo)

compare

public static ClassInfoComparisonResults compare(boolean checkBinary,
                                                 @Nullable
                                                 @Nullable AnnotationCheckMode annotationCheckMode,
                                                 ClassInfoCache baseCache,
                                                 ClassInfo baseClassInfo,
                                                 ClassInfoCache concreteCache,
                                                 @Nullable
                                                 @Nullable ClassInfo concreteClassInfo)

compare

public static ClassInfoComparisonResults compare(boolean checkBinary,
                                                 @Nullable
                                                 @Nullable AnnotationCheckMode annotationCheckMode,
                                                 java.util.List<java.lang.String> internalAnnotations,
                                                 InternalAnnotationCheckMode internalAnnotationCheckMode,
                                                 ClassInfoCache baseCache,
                                                 ClassInfo baseClassInfo,
                                                 ClassInfoCache concreteCache,
                                                 @Nullable
                                                 @Nullable ClassInfo concreteClassInfo)

isVisibilityLowered

public static boolean isVisibilityLowered(boolean checkBinary,
                                          int baseAccess,
                                          int inputAccess)

isMadeAbstract

public static boolean isMadeAbstract(boolean classVisible,
                                     int baseAccess,
                                     int inputAccess)

isVisible

public static boolean isVisible(boolean checkBinary,
                                int access)

isMadeFinal

public static boolean isMadeFinal(boolean checkBinary,
                                  int baseAccess,
                                  int inputAccess)

isInternalApi

public static boolean isInternalApi(MemberInfo memberInfo,
                                    java.util.List<java.lang.String> internalAnnotations,
                                    InternalAnnotationCheckMode checkMode)

isInternalApi

public static boolean isInternalApi(MemberInfo memberInfo,
                                    java.util.List<java.lang.String> internalAnnotations,
                                    InternalAnnotationCheckMode checkMode,
                                    @Nullable
                                    @Nullable ClassInfo packageInfo)

checkAnnotations

public static <I extends MemberInfo> void checkAnnotations(@Nullable
                                                           @Nullable AnnotationCheckMode mode,
                                                           ClassInfoComparisonResults results,
                                                           I memberInfo,
                                                           java.util.List<AnnotationInfo> baseAnnotations,
                                                           java.util.List<AnnotationInfo> concreteAnnotations)

checkAnnotations

public static <I extends MemberInfo> void checkAnnotations(@Nullable
                                                           @Nullable AnnotationCheckMode mode,
                                                           ClassInfoComparisonResults results,
                                                           I memberInfo,
                                                           boolean isError,
                                                           java.util.List<AnnotationInfo> baseAnnotations,
                                                           java.util.List<AnnotationInfo> concreteAnnotations)

hasSuperClass

public static boolean hasSuperClass(ClassInfoCache cache,
                                    ClassInfo classInfo,
                                    java.lang.String superClass)

getMethodInfo

@Nullable
public static @Nullable MethodInfo getMethodInfo(ClassInfo classInfo,
                                                           java.util.List<ClassInfo> parents,
                                                           boolean isStatic,
                                                           java.lang.String methodName,
                                                           java.lang.String methodDesc)

getFieldInfo

@Nullable
public static @Nullable FieldInfo getFieldInfo(ClassInfo classInfo,
                                                         java.util.List<ClassInfo> parents,
                                                         boolean isStatic,
                                                         java.lang.String fieldName)

getParentClassNames

public static java.util.List<java.lang.String> getParentClassNames(boolean checkBinary,
                                                                   ClassInfoCache cache,
                                                                   ClassInfo classInfo,
                                                                   boolean includeSuper)

Returns a list of parent class names, both super classes and interfaces. The list is sorted based on the topological order of the class hierarchy for each parent.

Parameters:

checkBinary - if true, super classes of all visibilities will be included. Otherwise, only public and protected super classes will be included.

includeSuper - if true, super classnames will be included. Otherwise, only interfaces will be, including those present on super classes.

Returns:

a list of parent class names, both super classes and interfaces

getParentClassInfos

public static java.util.List<ClassInfo> getParentClassInfos(boolean checkBinary,
                                                            ClassInfoCache cache,
                                                            ClassInfo classInfo,
                                                            boolean includeSuper)

Returns a list of parent class infos, both super classes and interfaces. The list is sorted based on the topological order of the class hierarchy for each parent.

Parameters:

checkBinary - if true, super classes of all visibilities will be included. Otherwise, only public and protected super classes will be included.

includeSuper - if true, super class infos will be included. Otherwise, only interfaces will be, including those present on super classes.

Returns:

a list of parent class infos, both super classes and interfaces