Package net.sf.jasperreports.extensions

Class ExtensionsEnvironment

java.lang.Object
net.sf.jasperreports.extensions.ExtensionsEnvironment
public final class ExtensionsEnvironment extends Object
A class that provides means of setting and accessing ExtensionsRegistry instances.
Author:
Lucian Chirita (lucianc@users.sourceforge.net)
See Also:

  • Field Details

    • EXCEPTION_MESSAGE_KEY_NULL_EXTENSIONS_REGISTRY

      public static final String EXCEPTION_MESSAGE_KEY_NULL_EXTENSIONS_REGISTRY
      See Also:

    • NULL_CACHE_KEY

      protected static final Object NULL_CACHE_KEY

    • PROPERTY_EXTENSIONS_REGISTRY_CLASS

      public static final String PROPERTY_EXTENSIONS_REGISTRY_CLASS
      A property that provides the default ExtensionsRegistry implementation class.

      This property is only read at initialization time, therefore changing the property value at a later time will have no effect.

      See Also:

  • Method Details

    • getSystemExtensionsRegistry

      public static ExtensionsRegistry getSystemExtensionsRegistry()
      Returns the system default extensions registry object.

      This is either the one instantiated based on PROPERTY_EXTENSIONS_REGISTRY_CLASS, or the one set by setSystemExtensionsRegistry(ExtensionsRegistry).

      Returns:
      the system default extensions registry object

    • setSystemExtensionsRegistry

      public static void setSystemExtensionsRegistry(ExtensionsRegistry extensionsRegistry)
      Sets the system default extensions registry.
      Parameters:
      extensionsRegistry - the extensions registry

    • getThreadExtensionsRegistry

      public static ExtensionsRegistry getThreadExtensionsRegistry()
      Returns the thread extensions registry, if any.
      Returns:
      the thread extensions registry

    • setThreadExtensionsRegistry

      public static void setThreadExtensionsRegistry(ExtensionsRegistry extensionsRegistry)
      Sets the thread extensions registry.
      Parameters:
      extensionsRegistry -
      See Also:

    • resetThreadExtensionsRegistry

      public static void resetThreadExtensionsRegistry()
      Resets (to null) the thread extensions registry.
      See Also:

    • getExtensionsRegistry

      public static ExtensionsRegistry getExtensionsRegistry()
      Returns the extensions registry to be used in the current context.

      The method returns the thread extensions registry (as returned by getThreadExtensionsRegistry()) if it exists, and the system registry (as returned by getSystemExtensionsRegistry()) otherwise.

      Returns:
      the context extensions registry

    • getExtensionsCacheKey

      public static Object getExtensionsCacheKey()
      Returns an object that can be used as cache key for extension-related caches.
      Returns:
      an extension-related cache key