Class CustomCodeRule


  • public abstract class CustomCodeRule
    extends java.lang.Object

    The CustomCodeRule class is designed to allow developers to extend InstallAnywhere's core functionality by creating custom rules that can be integrated with InstallAnywhere installers.

    There are several services and classes that can be used with and help classes that extend CustomCodeRule to provide additional functionality for an installer.

    See Also:
    CustomCodeRuleProxy, InstallerResources, SimpleRegistryManager
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected static CustomCodeRuleProxy ruleProxy
      This class variable provides access to designer-specified resources, system and user-defined variables, and international resources.
    • Constructor Summary

      Constructors 
      Constructor Description
      CustomCodeRule()  
    • Field Detail

      • ruleProxy

        protected static CustomCodeRuleProxy ruleProxy

        This class variable provides access to designer-specified resources, system and user-defined variables, and international resources.

        As a class variable, this instance is available to all methods of a CustomCodeRule implementation

        See Also:
        CustomCodeRuleProxy
    • Constructor Detail

      • CustomCodeRule

        public CustomCodeRule()
    • Method Detail

      • setCustomCodeRuleProxy

        public static void setCustomCodeRuleProxy​(CustomCodeRuleProxy ccrp)

        This method sets the CustomCodeRuleProxy variable to make it available for use in the custom code rule. This method should not be called or overridden by CustomCodeRule subclasses.

        Parameters:
        ccrp - Used to initialize the ruleProxy class variable, provides access to designer-specified resources, system and user-defined variables, and international resources.
        See Also:
        CustomCodeRuleProxy
      • evaluateRule

        public abstract boolean evaluateRule()

        This method is called at install-time when evaluating the rules set on a given installer action.

        It is very important that this method return quickly so that unnecessary lag is not experienced in the installer.

        Returns:
        true if the rule has evaluated to true (i.e., positive case), false otherwise.
        See Also:
        CustomCodeRuleProxy