Interface Rules

public interface Rules
Checks if access to a class member is allowed or denied, defined by a set of rules, built using a RulesBuilder.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Rules.ForClass
    Checks access to constructors or methods, for a specific class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String, DenyAction>
    denialsForMethod(CharSequence name, CharSequence descriptor)
    For the given method name and descriptor, return a map of classes which have an explicit deny rule against a matching method.
    Rules.ForClass
    forClass(Module caller, CharSequence packageName, CharSequence className)
    Returns the rules for a specific target class, as specified by its package name and class name.
    default Rules.ForClass
    forClass(Module caller, Class<?> target)
    Returns the rules for a specific target class.
    ModuleLayer
    moduleLayer()
    Returns the ModuleLayer that these rules apply to, which is applicable to the target classes.

  • Method Details

    • moduleLayer

      ModuleLayer moduleLayer()
      Returns the ModuleLayer that these rules apply to, which is applicable to the target classes.

    • forClass

      Rules.ForClass forClass(Module caller, CharSequence packageName, CharSequence className)
      Returns the rules for a specific target class, as specified by its package name and class name.
      Parameters:
      caller - the module which contains the caller class
      packageName - package name must have '/' characters as separators
      className - non-qualified class name
      Returns:
      a non-null ForClass instance

    • forClass

      default Rules.ForClass forClass(Module caller, Class<?> target)
      Returns the rules for a specific target class.
      Parameters:
      caller - the module which contains the caller class
      target - the target class
      Returns:
      a non-null ForClass instance

    • denialsForMethod

      Map<String, DenyAction> denialsForMethod(CharSequence name, CharSequence descriptor)
      For the given method name and descriptor, return a map of classes which have an explicit deny rule against a matching method. If none match, the returned map is empty.
      Parameters:
      name - method name
      descriptor - descriptor for the parameters, including parenthesis, but the return type is optional
      Returns:
      a non-null map of fully qualified class names to deny actions; '/' characters are used as separators