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

Class ProvidesComponentTypeCreator

  • public class ProvidesComponentTypeCreator
extends Component
    This class constructs a ProvidesComponentType. It is used to create the 'ProvidesComponentType' object step-by-step, i.e. 'ProvidesComponentTypeCreator' objects are of intermediate state.
    See Also:
    ProvidesComponentType

    • Constructor Detail

      • ProvidesComponentTypeCreator

        public ProvidesComponentTypeCreator​(RepositoryCreator repo)

    • Method Detail

      • withName

        public ProvidesComponentTypeCreator 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

      • provides

        public ProvidesComponentTypeCreator provides​(OperationInterfaceCreator interfce,
                                             String name)
        Description copied from class: Component
        Creates an OperationProvidedRole connection with the name name between the component and the OperationInterface interfce and adds it to the component. Setting the name is important for referencing if the role is used in a connector of a composite component and/or subsystem later on.

        Create a new operation interface by using the org.palladiosimulator.generator.fluent.component.factory, i.e. create.newOperationInterface().

        Overrides:
        provides in class Component
        Returns:
        this component
        See Also:
        FluentRepositoryFactory.newOperationInterface()

      • provides

        public ProvidesComponentTypeCreator provides​(org.palladiosimulator.pcm.repository.OperationInterface interfce)
        Description copied from class: Component
        Creates an OperationProvidedRole connection between the component and the OperationInterface interfce and adds it to the component.

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

        Overrides:
        provides in class Component
        Returns:
        this component
        See Also:
        FluentRepositoryFactory.fetchOfOperationInterface(String)

      • provides

        public ProvidesComponentTypeCreator provides​(org.palladiosimulator.pcm.repository.OperationInterface interfce,
                                             String name)
        Description copied from class: Component
        Creates an OperationProvidedRole connection with the name name between the component and the OperationInterface interfce and adds it to the component. Setting the name is important for referencing if the role is used in a connector of a composite component and/or subsystem later on.

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

        Overrides:
        provides in class Component
        Returns:
        this component
        See Also:
        FluentRepositoryFactory.fetchOfOperationInterface(String)

      • providesInfrastructure

        public ProvidesComponentTypeCreator providesInfrastructure​(org.palladiosimulator.pcm.repository.InfrastructureInterface interfce)
        Description copied from class: Component
        Creates an InfrastructureProvidedRole connection between the component and the InfrastructureInterface interfce and adds it to the component.

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

        Overrides:
        providesInfrastructure in class Component
        Returns:
        this component
        See Also:
        FluentRepositoryFactory.fetchOfInfrastructureInterface(String)

      • providesInfrastructure

        public ProvidesComponentTypeCreator providesInfrastructure​(org.palladiosimulator.pcm.repository.InfrastructureInterface interfce,
                                                           String name)
        Description copied from class: Component
        Creates an InfrastructureProvidedRole connection with the name name between the component and the InfrastructureInterface interfce and adds it to the component. Setting the name is important for referencing if the role is used in a connector of a composite component and/or subsystem later on.

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

        Overrides:
        providesInfrastructure in class Component
        Returns:
        this component
        See Also:
        FluentRepositoryFactory.fetchOfInfrastructureInterface(String)

      • handles

        public ProvidesComponentTypeCreator handles​(EventGroupCreator eventGroup,
                                            String name)
        Description copied from class: Component
        Creates a SinkRole connection with the name name between the component and the EventGroup eventGroup and adds it to the component. Setting the name is important for referencing if the role is used in a connector of a composite component and/or subsystem later on.

        Create a new event group by using the org.palladiosimulator.generator.fluent.component.factory, i.e. create.newEventGroup().

        Overrides:
        handles in class Component
        Returns:
        this component
        See Also:
        FluentRepositoryFactory.newEventGroup()

      • handles

        public ProvidesComponentTypeCreator handles​(org.palladiosimulator.pcm.repository.EventGroup eventGroup)
        Description copied from class: Component
        Creates a SinkRole connection between the component and the EventGroup eventGroup and adds it to the component.

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

        Overrides:
        handles in class Component
        Returns:
        this component
        See Also:
        FluentRepositoryFactory.fetchOfEventGroup(String)

      • handles

        public ProvidesComponentTypeCreator handles​(org.palladiosimulator.pcm.repository.EventGroup eventGroup,
                                            String name)
        Description copied from class: Component
        Creates a SinkRole connection with the name name between the component and the EventGroup eventGroup and adds it to the component. Setting the name is important for referencing if the role is used in a connector of a composite component and/or subsystem later on.

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

        Overrides:
        handles in class Component
        Returns:
        this component
        See Also:
        FluentRepositoryFactory.fetchOfEventGroup(String)

      • requires

        public ProvidesComponentTypeCreator requires​(OperationInterfaceCreator interfce,
                                             String name)
        Description copied from class: Component
        Creates an OperationRequiredRole connection with the name name between the component and the OperationInterface interfce and adds it to the component. Setting the name is important for referencing if the role is used in a connector of a composite component and/or subsystem later on.

        Create a new operation interface by using the org.palladiosimulator.generator.fluent.component.factory, i.e. create.newOperationInterface().

        Overrides:
        requires in class Component
        Returns:
        this component
        See Also:
        FluentRepositoryFactory.newOperationInterface()

      • requires

        public ProvidesComponentTypeCreator requires​(org.palladiosimulator.pcm.repository.OperationInterface interfce)
        Description copied from class: Component
        Creates an OperationRequiredRole connection between the component and the OperationInterface interfce and adds it to the component.

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

        Overrides:
        requires in class Component
        Returns:
        this component
        See Also:
        FluentRepositoryFactory.fetchOfOperationInterface(String)

      • requires

        public ProvidesComponentTypeCreator requires​(org.palladiosimulator.pcm.repository.OperationInterface interfce,
                                             String name)
        Description copied from class: Component
        Creates an OperationRequiredRole connection with the name name between the component and the OperationInterface interfce and adds it to the component. Setting the name is important for referencing if the role is used in a connector of a composite component and/or subsystem later on.

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

        Overrides:
        requires in class Component
        Returns:
        this component
        See Also:
        FluentRepositoryFactory.fetchOfOperationInterface(String)

      • requiresInfrastructure

        public ProvidesComponentTypeCreator requiresInfrastructure​(org.palladiosimulator.pcm.repository.InfrastructureInterface interfce)
        Description copied from class: Component
        Creates an InfrastructureRequiredRole connection between the component and the InfrastructureInterface interfce and adds it to the component.

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

        Overrides:
        requiresInfrastructure in class Component
        Returns:
        this component
        See Also:
        FluentRepositoryFactory.fetchOfInfrastructureInterface(String)

      • requiresInfrastructure

        public ProvidesComponentTypeCreator requiresInfrastructure​(org.palladiosimulator.pcm.repository.InfrastructureInterface interfce,
                                                           String name)
        Description copied from class: Component
        Creates an InfrastructureRequiredRole connection with the name name between the component and the InfrastructureInterface interfce and adds it to the component. Setting the name is important for referencing if the role is used in a connector of a composite component and/or subsystem later on.

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

        Overrides:
        requiresInfrastructure in class Component
        Returns:
        this component
        See Also:
        FluentRepositoryFactory.fetchOfInfrastructureInterface(String)

      • emits

        public ProvidesComponentTypeCreator emits​(EventGroupCreator eventGroup,
                                          String name)
        Description copied from class: Component
        Creates a SourceRole connection with the name name between the component and the EventGroup eventGroup and adds it to the component. Setting the name is important for referencing if the role is used in a connector of a composite component and/or subsystem later on.

        Create a new event group by using the org.palladiosimulator.generator.fluent.component.factory, i.e. create.newEventGroup().

        Overrides:
        emits in class Component
        Returns:
        this component
        See Also:
        FluentRepositoryFactory.newEventGroup()

      • emits

        public ProvidesComponentTypeCreator emits​(org.palladiosimulator.pcm.repository.EventGroup eventGroup)
        Description copied from class: Component
        Creates a SourceRole connection between the component and the EventGroup eventGroup and adds it to the component.

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

        Overrides:
        emits in class Component
        Returns:
        this component
        See Also:
        FluentRepositoryFactory.fetchOfEventGroup(String)

      • emits

        public ProvidesComponentTypeCreator emits​(org.palladiosimulator.pcm.repository.EventGroup eventGroup,
                                          String name)
        Description copied from class: Component
        Creates a SourceRole connection with the name name between the component and the EventGroup eventGroup and adds it to the component. Setting the name is important for referencing if the role is used in a connector of a composite component and/or subsystem later on.

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

        Overrides:
        emits in class Component
        Returns:
        this component
        See Also:
        FluentRepositoryFactory.fetchOfEventGroup(String)

      • requiresResource

        public ProvidesComponentTypeCreator requiresResource​(ResourceInterface resourceInterface)
        Description copied from class: Component
        Creates a ResourceRequiredRole connection between the component and the ResourceInterface resourceInterface and adds it to the component.

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

        Overrides:
        requiresResource in class Component
        Returns:
        this component
        See Also:
        org.palladiosimulator.generator.fluent.repository.factory.FluentRepositoryFactory#fetchOfResourceInterface(String)

      • requiresResource

        public ProvidesComponentTypeCreator requiresResource​(ResourceInterface resourceInterface,
                                                     String name)
        Description copied from class: Component
        Creates a ResourceRequiredRole connection with the name name between the component and the ResourceInterface resourceInterface and adds it to the component. Setting the name is important for referencing if the role is used in a connector of a composite component and/or subsystem later on.

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

        Overrides:
        requiresResource in class Component
        Returns:
        this component
        See Also:
        org.palladiosimulator.generator.fluent.repository.factory.FluentRepositoryFactory#fetchOfResourceInterface(String)

      • build

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