Interface JctFileManagerConfigurer

All Known Implementing Classes:
JctFileManagerAnnotationProcessorClassPathConfigurer, JctFileManagerJvmClassPathConfigurer, JctFileManagerJvmClassPathModuleConfigurer, JctFileManagerJvmModulePathConfigurer, JctFileManagerJvmSystemModulesConfigurer, JctFileManagerLoggingProxyConfigurer, JctFileManagerRequiredLocationsConfigurer, JctFileManagerWorkspaceConfigurer
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface JctFileManagerConfigurer
Interface for a JctFileManager configurer.

Configurers are designed to be chained to enable applying sets of operation to file managers during creation.

The configurer itself must return a JctFileManager instance. This will usually be the same value that is passed in the input parameter, as most configurers will only want to mutate an existing file manager. Configurers may instead opt to return a different file manager as the result, enabling wrapping the input in proxies or delegating implementations.

Configurers may also decide to not run at all by marking themselves as being disabled, which will result in them being skipped by any configurer chain or file manager that respects this attribute.

Since:
0.0.1
Author:
Ashley Scopes

  • Method Summary

    Modifier and Type
    Method
    Description
    JctFileManager
    configure(JctFileManager fileManager)
    Configure the file manager implementation.
    default boolean
    isEnabled()
    Determine if this configurer is enabled or not.

  • Method Details

    • configure

      JctFileManager configure(JctFileManager fileManager)
      Configure the file manager implementation.
      Parameters:
      fileManager - the file manager implementation.
      Returns:
      the new file manager (this may be the same as the input file manager).

    • isEnabled

      default boolean isEnabled()
      Determine if this configurer is enabled or not.

      Default implementations are enabled automatically unless otherwise specified.

      Returns:
      true if enabled, false if disabled.