Class OperationSignatureCreator
OperationSignature
. It is used to create the 'OperationSignature' object
step-by-step, i.e. 'OperationSignatureCreator' objects are of intermediate state.- See Also:
-
OperationSignature
-
Field Summary
Fields inherited from class org.palladiosimulator.generator.fluent.repository.structure.RepositoryEntity
repository
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected org.palladiosimulator.pcm.repository.OperationSignature
build()
Turns the entity in the making into the finished entity.withExceptionType
(org.palladiosimulator.pcm.repository.ExceptionType exceptionType) Adds theexceptionType
to the operation signature's list of possible org.palladiosimulator.generator.fluent.exceptions.withFailureType
(Failure failureType) Adds thefailureType
to the operation signature's list of possible failures.withFailureType
(org.palladiosimulator.pcm.reliability.FailureType failureType) Adds thefailureType
to the operation signature's list of possible failures.Defines the unique name of this current entity.withParameter
(String name, Primitive dataType, org.palladiosimulator.pcm.repository.ParameterModifier modifier) Creates aParameter
and adds it to the signature's ordered list of parameters.withParameter
(String name, org.palladiosimulator.pcm.repository.DataType dataType, org.palladiosimulator.pcm.repository.ParameterModifier modifier) Creates aParameter
and adds it to the signature's ordered list of parameters.withReturnType
(Primitive returnType) Defines thereturnType
of the operation signature.withReturnType
(org.palladiosimulator.pcm.repository.DataType returnType) Defines thereturnType
of the operation signature.
-
Constructor Details
-
OperationSignatureCreator
-
-
Method Details
-
withName
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. -
withReturnType
public OperationSignatureCreator withReturnType(org.palladiosimulator.pcm.repository.DataType returnType) Defines thereturnType
of the operation signature.An existing data type can be fetched from the repository using the org.palladiosimulator.generator.fluent.component.factory, i.e.
create.fetchOfDataType(name)
.- Parameters:
returnType
-- Returns:
- this operation signature in the making
- See Also:
-
withReturnType
Defines thereturnType
of the operation signature.A
Primitive
data type can have the values 'boolean', 'integer', 'string', 'double', 'long', 'char', 'byte'.- Parameters:
returnType
-- Returns:
- this operation signature in the making
-
withParameter
public OperationSignatureCreator withParameter(String name, Primitive dataType, org.palladiosimulator.pcm.repository.ParameterModifier modifier) Creates aParameter
and adds it to the signature's ordered list of parameters.Each parameter is a tuple of a
name
and adataType
(which is unique across the parameters). Optionally, themodifier
s 'in', 'out', and 'inout' (with its OMG IDL semantics) can be used for parameters, e.g.ParameterModifier.IN
.A
Primitive
data type can have the values 'boolean', 'integer', 'string', 'double', 'long', 'char', 'byte'.- Parameters:
name
-dataType
-modifier
- may be null- Returns:
- this operation signature in the making
- See Also:
-
ParameterModifier
-
withParameter
public OperationSignatureCreator withParameter(String name, org.palladiosimulator.pcm.repository.DataType dataType, org.palladiosimulator.pcm.repository.ParameterModifier modifier) Creates aParameter
and adds it to the signature's ordered list of parameters.Each parameter is a tuple of a
name
and adataType
(which is unique across the parameters). Optionally, themodifier
s 'in', 'out', and 'inout' (with its OMG IDL semantics) can be used for parameters, e.g.ParameterModifier.IN
.An existing data type can be fetched from the repository using the org.palladiosimulator.generator.fluent.component.factory, i.e.
create.fetchOfDataType(name)
.- Parameters:
name
-dataType
-modifier
- may be null- Returns:
- this operation signature in the making
- See Also:
-
FluentRepositoryFactory.fetchOfDataType(String)
ParameterModifier
-
withFailureType
public OperationSignatureCreator withFailureType(org.palladiosimulator.pcm.reliability.FailureType failureType) Adds thefailureType
to the operation signature's list of possible failures.Failure types can be fetched from the repository using the org.palladiosimulator.generator.fluent.component.factory, i.e.
create.fetchOfFailureType(name)
.- Parameters:
failureType
-- Returns:
- this operation signature in the making
- See Also:
-
withFailureType
Adds thefailureType
to the operation signature's list of possible failures.A
Failure
type can have the values 'HARDWARE_CPU', 'HARDWARE_HDD', 'HARDWARE_DELAY', 'NETWORK_LAN', 'SOFTWARE'.- Parameters:
failureType
-- Returns:
- this operation signature in the making
-
withExceptionType
public OperationSignatureCreator withExceptionType(org.palladiosimulator.pcm.repository.ExceptionType exceptionType) Adds theexceptionType
to the operation signature's list of possible org.palladiosimulator.generator.fluent.exceptions.An existing exception type can be fetched from the repository using the org.palladiosimulator.generator.fluent.component.factory, i.e.
create.fetchOfExceptionType(name)
.- Parameters:
exceptionType
-- Returns:
- this operation signature in the making
- See Also:
-
build
protected org.palladiosimulator.pcm.repository.OperationSignature build()Description copied from class:Entity
Turns the entity in the making into the finished entity.
-