Package org.somda.sdc.glue.common.factory

Interface ModificationsBuilderFactory

public interface ModificationsBuilderFactory
Factory to create ModificationsBuilder instances.

  • Method Details

    • createModificationsBuilder

      ModificationsBuilder createModificationsBuilder(Mdib mdib)
      Creates a ModificationsBuilder instance.

      Important note: the MDIB passed to the ModificationsBuilder will be modified. Make sure to pass a copy if necessary.

      Parameters:
      mdib - the MDIB used to create the modifications from.
      Returns:
      a new ModificationsBuilder.
      Throws:
      RuntimeException - if a single state descriptor does not have a corresponding state.

    • createModificationsBuilder

      ModificationsBuilder createModificationsBuilder(Mdib mdib, Boolean createSingleStateIfMissing)
      Creates a ModificationsBuilder instance.

      Important note: the MDIB passed to the ModificationsBuilder will be modified. Make sure to pass a copy if necessary.

      Parameters:
      mdib - the MDIB used to create the modifications from.
      createSingleStateIfMissing - if true then the builder tries to create a missing single state; if false then a runtime exception is thrown is a single state is missing. If single states are added automatically, then RequiredDefaultStateValues will be used to populate default values.
      Returns:
      a new ModificationsBuilder instance.

    • createModificationsBuilder

      ModificationsBuilder createModificationsBuilder(Mdib mdib, Boolean createSingleStateIfMissing, @Nullable DefaultStateValues defaultStateValues)
      Creates a ModificationsBuilder instance.

      Important note: the MDIB passed to the ModificationsBuilder will be modified. Make sure to pass a copy if necessary.

      Parameters:
      mdib - the MDIB used to create the modifications from.
      createSingleStateIfMissing - if true then the builder tries to create a missing single state; if false then a runtime exception is thrown is a single state is missing.
      defaultStateValues - defines callbacks for the builder to apply default state values. If null, then RequiredDefaultStateValues will be used to populate default values. This parameter does only take effect if createSingleStateIfMissing is true.
      Returns:
      a new ModificationsBuilder instance.