Package kieker.analysis.plugin.reader.list

Class ListReader<T>

java.lang.Object
kieker.analysis.analysisComponent.AbstractAnalysisComponent
kieker.analysis.plugin.AbstractPlugin
kieker.analysis.plugin.reader.AbstractReaderPlugin
kieker.analysis.plugin.reader.list.ListReader<T>
Type Parameters:
T -
All Implemented Interfaces:
IAnalysisComponent, IPlugin, IReaderPlugin
@Deprecated
public class ListReader<T>
extends AbstractReaderPlugin
Deprecated.
1.15 This helper class is not necessary to test TeeTime based stages
Helper class that reads records added using the methods addAllObjects(List) or addObject(Object). Depending on the value of the Configuration variable "awaitTermination", either the read() method returns immediately, or awaits a termination via AnalysisController.terminate(). Additions after this reader starts reading are ignored.
Since:
1.6
Author:
Andre van Hoorn, Jan Waller

  • Field Details

    • OUTPUT_PORT_NAME

      public static final java.lang.String OUTPUT_PORT_NAME
      Deprecated.
      The name of the output port delivering the read objects.
      See Also:
      Constant Field Values

    • CONFIG_PROPERTY_NAME_AWAIT_TERMINATION

      public static final java.lang.String CONFIG_PROPERTY_NAME_AWAIT_TERMINATION
      Deprecated.
      The name of the configuration determining whether the reader terminates after all objects have been delivered of whether it waits for a terminate signal.
      See Also:
      Constant Field Values

  • Constructor Details

    • ListReader

      public ListReader​(Configuration configuration, IProjectContext projectContext)
      Deprecated.
      Creates a new instance of this class using the given parameters.
      Parameters:
      configuration - The configuration for this component.
      projectContext - The project context for this component.

  • Method Details

    • addAllObjects

      public void addAllObjects​(java.util.List<T> records)
      Deprecated.
      This method adds all given records to our list.
      Parameters:
      records - The records to be added.

    • addObject

      public void addObject​(T object)
      Deprecated.
      This method adds the given object to our list.
      Parameters:
      object - The object to be added.

    • read

      public boolean read()
      Deprecated.
      Starts the reader. This method is intended to be a blocking operation, i.e., it is assumed that reading has finished before this method returns. The method should indicate an error by the return value false. In asynchronous scenarios, the IPlugin.terminate(boolean) method can be used to initiate the termination of this method.
      Returns:
      true if reading was successful; false if an error occurred

    • terminate

      public void terminate​(boolean error)
      Deprecated.
      Initiates a termination of the plugin. This method is only used by the framework and should not be called manually. Use the method AnalysisController.terminate(boolean) instead. After receiving this notification, the plugin should terminate any running methods, e.g., read for readers.
      Parameters:
      error - Determines whether the plugin is terminated due to an error or not.

    • getCurrentConfiguration

      public Configuration getCurrentConfiguration()
      Deprecated.
      This method should deliver a Configuration object containing the current configuration of this instance. In other words: The constructor should be able to use the given object to initialize a new instance of this class with the same intern properties.
      Specified by:
      getCurrentConfiguration in interface IAnalysisComponent
      Specified by:
      getCurrentConfiguration in interface IPlugin
      Specified by:
      getCurrentConfiguration in class AbstractAnalysisComponent
      Returns:
      A completely filled configuration object.