\r\n

51Degrees Pipeline Java  4.3

51Degrees Pipeline for Java

fiftyone.pipeline.core.configuration.ElementOptions Class Reference

Detailed Description

Configuration object that describes how to build a FlowElement.

Collaboration diagram for fiftyone.pipeline.core.configuration.ElementOptions:

[legend]

Public Member Functions

 ElementOptions ()
Public constructor needed for XML binding.

Public Attributes

String  builderName
The name of the builder to use when creating the FlowElement. More...
Map< String, Object >  buildParameters
The dictionary keys are method names or names of parameters on the build method of the builder. More...
List< ElementOptions >  subElements
If this property is populated, the flow element is a fiftyone.pipeline.core.flowelements.ParallelElements instance. More...

Member Data Documentation

◆ builderName

String fiftyone.pipeline.core.configuration.ElementOptions.builderName

The name of the builder to use when creating the FlowElement.

This does not necessarily have to be the full name of the type. The system will match on:

  1. Exact match of type name
  2. Convention based match by removing 'Builder' from the end of the type name. e.g. a BuilderName value of 'DeviceDetectionEngine' would match to 'DeviceDetectionEngineBuilder'
  3. Matching on an ElementBuilder#alternateName() annotation. e.g. a BuilderName value 'DDEngine' would match to 'DeviceDetectionEngineBuilder' if that class was also annotated with '@ElementBuilder(alternateName = "DDEngine")'.

◆ buildParameters

Map<String, Object> fiftyone.pipeline.core.configuration.ElementOptions.buildParameters

The dictionary keys are method names or names of parameters on the build method of the builder.

The value is the parameter value. Similar to the BuilderName, the key value does not necessarily have to be the full name of the method. The system will match on:

  1. Exact match of method name
  2. Convention based match by removing 'set' from the start of the method name. e.g. a key value of 'AutomaticUpdatesEnabled' would match to method 'setAutomaticUpdatesEnabled'
  3. Matching on an AlternateName. e.g. a key value of 'AutoUpdates' would match to 'setAutoUpdateEnabled' if that method was also annotated with '@AlternateName("AutoUpdates")'.

◆ subElements

List<ElementOptions> fiftyone.pipeline.core.configuration.ElementOptions.subElements

If this property is populated, the flow element is a fiftyone.pipeline.core.flowelements.ParallelElements instance.

builderName and buildParameters should be ignored. Each options instance within subElements contains the configuration for an element to be added to a fiftyone.pipeline.core.flowelements.ParallelElements instance. A fiftyone.pipeline.core.flowelements.ParallelElements always executes all it's children in parallel so the ordering of this elements is irrelevant.