Package it.unive.lisa

Class LiSAFactory

  • public final class LiSAFactory
extends java.lang.Object
    An utility class for instantiating analysis components, that is, modular pieces of the analysis that have several implementations. The default instance for a component can be retrieved through getDefaultFor(Class, Object...), while a specific instance can be retrieved through getInstance(Class, Object...). Note that custom defaults for each component can be defined through registerDefaultFor(Class, Class).

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  LiSAFactory.ConfigurableComponent<T>
      An analysis component that can be configured, that is, it has more than one implementation that can be modularly integrated into the analysis.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.util.Collection<LiSAFactory.ConfigurableComponent<?>> configurableComponents()
      Yields the collection of LiSAFactory.ConfigurableComponents that can be used to customize the analysis.
      static <T> T getDefaultFor​(java.lang.Class<T> component, java.lang.Object... params)
      Builds the default instance of the specified analysis component.
      static <T> T getInstance​(java.lang.Class<T> component, java.lang.Object... params)
      Creates an instance of the given component.
      static void registerDefaultFor​(java.lang.Class<?> component, java.lang.Class<?> defaultImplementation)
      Registers a default implementation for component, taking precedence over the defaults defined through DefaultImplementation.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getInstance

        public static <T> T getInstance​(java.lang.Class<T> component,
                                java.lang.Object... params)
                         throws AnalysisSetupException
        Creates an instance of the given component. If params are provided, a suitable constructor (and not ambiguous) must exist in component's class. Otherwise, component's class in inspected for the presence of a DefaultParameters annotations. If found, the instance will be created by passing to the constructor instances of those parameters obtained through getInstance(Class, Object...) without passing any params. Otherwise, the nullary constructor of component is invoked.
        Type Parameters:
        T - the type of the component
        Parameters:
        component - the component to instantiate
        params - the parameters for the creation
        Returns:
        an instance of the given component
        Throws:
        AnalysisSetupException - if the component cannot be created

      • registerDefaultFor

        public static void registerDefaultFor​(java.lang.Class<?> component,
                                      java.lang.Class<?> defaultImplementation)
        Registers a default implementation for component, taking precedence over the defaults defined through DefaultImplementation. Any previous default for component introduced by calling this method is removed.
        Parameters:
        component - the component whose default implementation is to be registered
        defaultImplementation - the new default implementation for component

      • getDefaultFor

        public static <T> T getDefaultFor​(java.lang.Class<T> component,
                                  java.lang.Object... params)
                           throws AnalysisSetupException
        Builds the default instance of the specified analysis component. The instance to create is retrieved by first looking into the custom defaults provided through registerDefaultFor(Class, Class) If no entry for component has been provided, then the instance from the component's DefaultImplementation annotation. If component is not annotated with such an annotation, then an AnalysisSetupException is thrown. Then, getInstance(Class, Object...) is invoked on the retrieved instance, using the given params. If the default instance is a NonRelationalDomain and the component is a HeapDomain or ValueDomain, then the instance is wrapped into the appropriate environment (either HeapEnvironment or ValueEnvironment) before being returned.
        Type Parameters:
        T - the type of the component
        Parameters:
        component - the component to instantiate
        params - the parameters for the creation of the default instance
        Returns:
        an instance of the default implementation of the given component
        Throws:
        AnalysisSetupException - if the default implementation cannot be created