Class OperationInterfaceCreator
- 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.OperationInterfaceCreator
-
public class OperationInterfaceCreator extends Interface
This class constructs anOperationInterface
. It is used to create the 'OperationInterface' object step-by-step, i.e. 'OperationInterfaceCreator' objects are of intermediate state.- See Also:
OperationInterface
-
-
Field Summary
-
Fields inherited from class org.palladiosimulator.generator.fluent.repository.structure.interfaces.Interface
parentInterfaces, requiredCharacterisations
-
Fields inherited from class org.palladiosimulator.generator.fluent.repository.structure.RepositoryEntity
repository
-
-
Constructor Summary
Constructors Constructor Description OperationInterfaceCreator(RepositoryCreator repo)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
addOperationSignatures(org.palladiosimulator.pcm.repository.OperationSignature signature)
org.palladiosimulator.pcm.repository.OperationInterface
build()
Turns the entity in the making into the finished entity.OperationInterfaceCreator
conforms(org.palladiosimulator.pcm.repository.Interface interfce)
Creates a conforming (parental) connection to theparentInterface
and adds it to this interface/event group.OperationInterfaceCreator
withName(String name)
Defines the unique name of this current entity.OperationInterfaceCreator
withOperationSignature(OperationSignatureCreator signature)
Adds thesignature
to this interface's list of signatures.OperationInterfaceCreator
withRequiredCharacterisation(org.palladiosimulator.pcm.repository.Parameter parameter, org.palladiosimulator.pcm.parameter.VariableCharacterisationType type)
Creates aRequiredCharacterisation
and adds it to the interface/event group.
-
-
-
Constructor Detail
-
OperationInterfaceCreator
public OperationInterfaceCreator(RepositoryCreator repo)
-
-
Method Detail
-
withName
public OperationInterfaceCreator 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.
-
conforms
public OperationInterfaceCreator conforms(org.palladiosimulator.pcm.repository.Interface interfce)
Description copied from class:Interface
Creates a conforming (parental) connection to theparentInterface
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 classInterface
- Returns:
- this interface/event group in the making
- See Also:
FluentRepositoryFactory.fetchOfInterface(String)
,Interface.getParentInterfaces__Interface()
,Interface
-
withRequiredCharacterisation
public OperationInterfaceCreator withRequiredCharacterisation(org.palladiosimulator.pcm.repository.Parameter parameter, org.palladiosimulator.pcm.parameter.VariableCharacterisationType type)
Description copied from class:Interface
Creates aRequiredCharacterisation
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.
TheVariableCharacterisationType
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)
andcreate.fetchOfParameter(name, signatureContext)
.- Overrides:
withRequiredCharacterisation
in classInterface
- Parameters:
parameter
- that is specifiedtype
- of the parameter- Returns:
- this interface/event group in the making
- See Also:
FluentRepositoryFactory.fetchOfParameter(String)
,FluentRepositoryFactory.fetchOfParameter(String, org.palladiosimulator.pcm.repository.Signature)
-
withOperationSignature
public OperationInterfaceCreator withOperationSignature(OperationSignatureCreator signature)
Adds thesignature
to this interface's list of signatures. Thesignature
can be created using the org.palladiosimulator.generator.fluent.component.factory, i.e.create.newOperationSignature()
.- Parameters:
signature
-- Returns:
- this operation interface in the making
- See Also:
FluentRepositoryFactory.newOperationSignature()
-
build
public org.palladiosimulator.pcm.repository.OperationInterface build()
Description copied from class:Entity
Turns the entity in the making into the finished entity.
-
addOperationSignatures
protected void addOperationSignatures(org.palladiosimulator.pcm.repository.OperationSignature signature)
-
-