Package org.palladiosimulator.generator.fluent.repository.structure.interfaces

Class InfrastructureInterfaceCreator

java.lang.Object
org.palladiosimulator.generator.fluent.shared.structure.Entity
org.palladiosimulator.generator.fluent.repository.structure.RepositoryEntity
org.palladiosimulator.generator.fluent.repository.structure.interfaces.Interface
org.palladiosimulator.generator.fluent.repository.structure.interfaces.InfrastructureInterfaceCreator
public class InfrastructureInterfaceCreator extends Interface
This class constructs an InfrastructureInterface. It is used to create the 'InfrastructureInterface' object step-by-step, i.e. 'InfrastructureInterfaceCreator' objects are of intermediate state.
See Also:
  • InfrastructureInterface

  • Constructor Details

    • InfrastructureInterfaceCreator

      public InfrastructureInterfaceCreator(RepositoryCreator repo)

  • Method Details

    • withName

      public InfrastructureInterfaceCreator withName(String name)
      Description copied from class: Entity
      Defines the unique name of this current entity. Once created entities are referenced by this name. Only entities with a unique name can be fetched from the model.
      Overrides:
      withName in class Entity
      Returns:
      this current entity in the making

    • conforms

      public InfrastructureInterfaceCreator conforms(org.palladiosimulator.pcm.repository.Interface interfce)
      Description copied from class: Interface
      Creates a conforming (parental) connection to the parentInterface and adds it to this interface/event group.

      An existing parentInterface can be fetched from the repository using the org.palladiosimulator.generator.fluent.component.factory, i.e. create.fetchOfInterface(name).

      Overrides:
      conforms in class Interface
      Returns:
      this interface/event group in the making
      See Also:

    • withRequiredCharacterisation

      public InfrastructureInterfaceCreator withRequiredCharacterisation(org.palladiosimulator.pcm.repository.Parameter parameter, org.palladiosimulator.pcm.parameter.VariableCharacterisationType type)
      Description copied from class: Interface
      Creates a RequiredCharacterisation and adds it to the interface/event group.

      A RequiredCharacterisation is a specification of parameters. It increases the power of the interfaces and enables extended interoperability checks.
      The VariableCharacterisationType type offers the values 'STRUCTURE', 'NUMBER_OF_ELEMENTS', 'BYTESIZE', 'TYPE', and 'VALUE'.

      An existing parameter from a previously defined signature/event type can be fetched from the repository using the org.palladiosimulator.generator.fluent.component.factory, i.e. create.fetchOfParameter(name) and create.fetchOfParameter(name, signatureContext).

      Overrides:
      withRequiredCharacterisation in class Interface
      Parameters:
      parameter - that is specified
      type - of the parameter
      Returns:
      this interface/event group in the making
      See Also:

    • withInfrastructureSignature

      public InfrastructureInterfaceCreator withInfrastructureSignature(InfrastructureSignatureCreator signature)
      Adds the signature to this interface's list of signatures. The signature can be created using the org.palladiosimulator.generator.fluent.component.factory, i.e. create.newInfrastructureSignature().
      Parameters:
      signature -
      Returns:
      this infrastructure interface in the making
      See Also:

    • build

      public org.palladiosimulator.pcm.repository.InfrastructureInterface build()
      Description copied from class: Entity
      Turns the entity in the making into the finished entity.
      Specified by:
      build in class Interface
      Returns:
      the finished entity

    • addInfrastructureSignatures

      protected void addInfrastructureSignatures(org.palladiosimulator.pcm.repository.InfrastructureSignature signature)