Package com.cryptomorin.xseries.reflection.constraint

Interface ReflectiveConstraint

All Known Implementing Classes:

ClassTypeConstraint, VisibilityConstraint

@Experimental
public interface ReflectiveConstraint

A set of checks performed on a ReflectiveHandle to determine whether it meets certain requirements based on its JVM signature before we can use it. Usually these are conditions that the standard Java's reflection API doesn't care about. For example, Class.forName(String) doesn't care whether the class is an enum/interface/abstract, but you could add these additional checks using ClassTypeConstraint.

If the check against appliesTo(ReflectiveHandle, Object) fails, a ReflectiveConstraintException should be thrown.

All constraints must be incompatible with each other. Menaing that two different constraints from the same class/category should not be able to co-exist.

This class should not be directly used in most cases.

Since:

12.0.0

See Also:

• VisibilityConstraint
• ClassTypeConstraint

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ReflectiveConstraint.Result

Method Summary

Modifier and Type	Method	Description
@NotNull ReflectiveConstraint.Result	appliesTo(@NotNull ReflectiveHandle<?> handle, @NotNull Object jvm)	Whether this constraint can be applied and applies to the given item.
String	category()	The category name of this constraint.
String	name()	The name of this constraint.

Method Details

category

@Contract(pure=true)
String category()

The category name of this constraint.

name

@Contract(pure=true)
String name()

The name of this constraint.

appliesTo

@NotNull
@Contract(pure=true)
@NotNull ReflectiveConstraint.Result appliesTo(@NotNull
 @NotNull ReflectiveHandle<?> handle,
 @NotNull
 @NotNull Object jvm)

Whether this constraint can be applied and applies to the given item.

Usually a ReflectiveConstraintException should be thrown if the result is either ReflectiveConstraint.Result.INCOMPATIBLE or ReflectiveConstraint.Result.NOT_MATCHED.

Parameters:

handle - the reflective handle of the object.

jvm - the corresponding JVM object (not MethodHandle) of the handle.

Returns:

Refer to ReflectiveConstraint.Result for details.