\r\n

51Degrees Pipeline Java  4.1Newer Version 4.4

51Degrees Pipeline for Java

fiftyone.pipeline.engines.flowelements.PrePackagedPipelineBuilderBase< TBuilder extends PrePackagedPipelineBuilderBase< TBuilder > Class Template Reference abstract

Detailed Description

Base class for pipeline builders that will produce a pipeline with specific flow elements.

Parameters
<TBuilder> - the builder type

Inheritance diagram for fiftyone.pipeline.engines.flowelements.PrePackagedPipelineBuilderBase< TBuilder extends PrePackagedPipelineBuilderBase< TBuilder >:

[legend]

Collaboration diagram for fiftyone.pipeline.engines.flowelements.PrePackagedPipelineBuilderBase< TBuilder extends PrePackagedPipelineBuilderBase< TBuilder >:

[legend]

Public Member Functions

 PrePackagedPipelineBuilderBase ()
Construct a new instance using the default ILoggerFactory implementation returned by the LoggerFactory#getILoggerFactory() method.
 PrePackagedPipelineBuilderBase (ILoggerFactory loggerFactory)
Construct a new instance. More...
TBuilder  useLazyLoading ()
Enable lazy loading of results. More...
TBuilder  useLazyLoading (long timeoutMillis)
Enable lazy loading of results. More...
TBuilder  useResultsCache ()
Enable caching of results. More...
TBuilder  useResultsCache (int size)
Enable caching of results. More...

Public Member Functions inherited from fiftyone.pipeline.core.flowelements.PipelineBuilderBase< T extends PipelineBuilderBase >

 PipelineBuilderBase ()
Construct a new instance using the default ILoggerFactory implementation returned by the LoggerFactory#getILoggerFactory() method.
 PipelineBuilderBase (ILoggerFactory loggerFactory)
Construct a new instance. More...
Pipeline  build () throws Exception
Build the Pipeline using the FlowElements added. More...
T  addFlowElement (FlowElement element)
Add a FlowElement to the Pipeline to be run in series. More...
T  addFlowElementsParallel (FlowElement[] elements)
Add an array of FlowElements to the Pipeline to be run in parallel. More...
T  setAutoCloseElements (boolean autoClose)
Configure the Pipeline to either call dispose on it's child FlowElements when it is disposed or not. More...
T  setSuppressProcessException (boolean suppress)
Configure the Pipeline to either suppress exceptions added to FlowData#getErrors() during processing or to throw them as an aggregate exception once processing is complete. More...

Protected Attributes

boolean  lazyLoading = false
boolean  resultsCache = false
long  lazyLoadingTimeoutMillis = 1000
int  resultsCacheSize = 1000

Protected Attributes inherited from fiftyone.pipeline.core.flowelements.PipelineBuilderBase< T extends PipelineBuilderBase >

final ILoggerFactory  loggerFactory
The ILoggerFactory used to create any loggers required by instances being built by the builder.
final Logger  logger
Logger created from loggerFactory to allow logging in this builder.
final List< FlowElement >  flowElements = new ArrayList<>()
List of flow elements to add to the Pipeline.
boolean  autoCloseElements = false
boolean  suppressProcessExceptions = false

Constructor & Destructor Documentation

◆ PrePackagedPipelineBuilderBase()

fiftyone.pipeline.engines.flowelements.PrePackagedPipelineBuilderBase< TBuilder extends PrePackagedPipelineBuilderBase< TBuilder >.PrePackagedPipelineBuilderBase ( ILoggerFactory   loggerFactory )

Construct a new instance.

Parameters
loggerFactory - the ILoggerFactory used to create any loggers required by instances being built by the builder

Member Function Documentation

◆ useLazyLoading() [1/2]

TBuilder fiftyone.pipeline.engines.flowelements.PrePackagedPipelineBuilderBase< TBuilder extends PrePackagedPipelineBuilderBase< TBuilder >.useLazyLoading ( )

Enable lazy loading of results.

Uses a default timeout of 5 seconds.

Returns
this builder instance

◆ useLazyLoading() [2/2]

TBuilder fiftyone.pipeline.engines.flowelements.PrePackagedPipelineBuilderBase< TBuilder extends PrePackagedPipelineBuilderBase< TBuilder >.useLazyLoading ( long   timeoutMillis )

Enable lazy loading of results.

Parameters
timeoutMillis - the timeout to use when attempting to access lazy-loaded values. Default is 5 seconds
Returns
this builder

◆ useResultsCache() [1/2]

TBuilder fiftyone.pipeline.engines.flowelements.PrePackagedPipelineBuilderBase< TBuilder extends PrePackagedPipelineBuilderBase< TBuilder >.useResultsCache ( )

Enable caching of results.

Uses a default cache size of 1000.

Returns
this builder

◆ useResultsCache() [2/2]

TBuilder fiftyone.pipeline.engines.flowelements.PrePackagedPipelineBuilderBase< TBuilder extends PrePackagedPipelineBuilderBase< TBuilder >.useResultsCache ( int   size )

Enable caching of results.

Parameters
size - the maximum number of results to hold in the device detection cache. Default is 1000
Returns
this builder
On This Page

Generated by doxygen 1.8.15