RestrictionChecker.java

package me.fallenbreath.conditionalmixin.api.checker;

import me.fallenbreath.conditionalmixin.api.annotation.Restriction;
import me.fallenbreath.conditionalmixin.api.mixin.RestrictionCheckFailureCallback;

/**
 * A helper class to for checking if {@link Restriction} annotation on a mixin class is satisfied
 */
public interface RestrictionChecker
{
	/**
	 * Check if the {@link Restriction} annotation of the given mixin class is satisfied
	 * <p>
	 * Special cases:
	 * <ul>
	 * <li>Return true if the mixin class doesn't have the {@link Restriction} annotation</li>
	 * <li>Return false if the mixin class does not exist</li>
	 * </ul>
	 *
	 * @param mixinClassName the target mixin class name to check dependency
	 */
	boolean checkRestriction(String mixinClassName);

	/**
	 * Set the callback function when the restriction check fails
	 */
	void setFailureCallback(RestrictionCheckFailureCallback failureCallback);
}