com.install4j.api.beans (install4j API)
Description: declaration: package: com.install4j.api.beans

# Package com.install4j.api.beans

package com.install4j.api.beans
This package contains the base classes for all extension points in install4j as well as special property classes.

See the API overview for general remarks on how to use the install4j API.

The specific interfaces of screens, actions and form components all implement the `Bean` marker interface.

All abstract base classes for screens, actions and form components extend the `AbstractBean` class that offers utility methods for replacing variables in user-configured property values.

This package also includes classes for property types of beans that are specially handled by install4j.

- Related Packages
  Package
  Description
  com.install4j.api
  This package contains general utility classes for the install4j API.
- Class
  Description
  AbstractBean
  Common base class for all abstract superclasses for beans that are handled by install4j.
  ActionList
  Property type for a configurable list of actions.
  Anchor
  Property type for an anchor.
  Bean
  Common interface for all types of beans that are handled by install4j.
  ErrorHandlingCallback
  Callback for deciding how an error should be handled.
  ErrorHandlingMode
  Indicates the action that should be taken after an error has occurred.
  ExternalFile
  Property type for files from outside the distribution tree to be used in beans.
  LocalizedExternalFile
  Container for a set of localized files that represent a single `ExternalFile` with textual content.
  PropertyLoggingInterceptor
  Interceptor interface for beans to modify property values that are written to the installer log file.
  ReplacementMode
  Variable replacement mode for string properties that are used in regular expressions.
  ScriptProperty
  Property type for script properties to be used in beans.
  UndefinedVariableException
  Exception that is thrown by the `replaceVariables(...)` methods in `AbstractBean` if a variable cannot be found the `VariableErrorHandling` for the corresponding variable type is `VariableErrorHandling.EXCEPTION`.
  VariableErrorHandling
  Used in `VariableErrorHandlingDescriptor` to configure the error handling for a single variable type.
  VariableErrorHandlingDescriptor
  Specifies the error handling for variable replacements.
  VisualContainerBean
  Implemented by beans that contain visual components.