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

Class EventTypeCreator

java.lang.Object

org.palladiosimulator.generator.fluent.shared.structure.Entity

org.palladiosimulator.generator.fluent.repository.structure.RepositoryEntity

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

public class EventTypeCreator
extends RepositoryEntity

This class constructs a EventType. It is used to create the 'EventType' object step-by-step, i.e. 'EventTypeCreator' objects are of intermediate state.

See Also:

EventType

Field Summary

Fields inherited from class org.palladiosimulator.generator.fluent.repository.structure.RepositoryEntity

repository

Fields inherited from class org.palladiosimulator.generator.fluent.shared.structure.Entity

name

Constructor Summary

Constructors

Constructor	Description
EventTypeCreator(RepositoryCreator repo)

Method Summary

Modifier and Type	Method	Description
protected org.palladiosimulator.pcm.repository.EventType	build()	Turns the entity in the making into the finished entity.
EventTypeCreator	withExceptionType(org.palladiosimulator.pcm.repository.ExceptionType exceptionType)	Adds the exceptionType to the event type's list of possible org.palladiosimulator.generator.fluent.exceptions.
EventTypeCreator	withFailureType(Failure failureType)	Adds the failureType to the event type's list of possible failures.
EventTypeCreator	withFailureType(org.palladiosimulator.pcm.reliability.FailureType failureType)	Adds the failureType to the event type's list of possible failures.
EventTypeCreator	withName(String name)	Defines the unique name of this current entity.
EventTypeCreator	withParameter(String name, Primitive dataType, org.palladiosimulator.pcm.repository.ParameterModifier modifier)	Creates a Parameter and adds it to the event type's ordered list of parameters.
EventTypeCreator	withParameter(String name, org.palladiosimulator.pcm.repository.DataType dataType, org.palladiosimulator.pcm.repository.ParameterModifier modifier)	Creates a Parameter and adds it to the event type's ordered list of parameters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventTypeCreator

public EventTypeCreator(RepositoryCreator repo)

Method Detail

withName

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

withParameter

public EventTypeCreator withParameter(String name,
                                      Primitive dataType,
                                      org.palladiosimulator.pcm.repository.ParameterModifier modifier)

Creates a Parameter and adds it to the event type's ordered list of parameters.

Each parameter is a tuple of a name and a dataType (which is unique across the parameters). Optionally, the modifiers '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 event type in the making

See Also:

ParameterModifier

withParameter

public EventTypeCreator withParameter(String name,
                                      org.palladiosimulator.pcm.repository.DataType dataType,
                                      org.palladiosimulator.pcm.repository.ParameterModifier modifier)

Creates a Parameter and adds it to the event type's ordered list of parameters.

Each parameter is a tuple of a name and a dataType (which is unique across the parameters). Optionally, the modifiers '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 event type in the making

See Also:

FluentRepositoryFactory.fetchOfDataType(String), ParameterModifier

withFailureType

public EventTypeCreator withFailureType(org.palladiosimulator.pcm.reliability.FailureType failureType)

Adds the failureType to the event type'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 event type in the making

See Also:

FluentRepositoryFactory.fetchOfFailureType(String)

withFailureType

public EventTypeCreator withFailureType(Failure failureType)

Adds the failureType to the event type'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 event type in the making

withExceptionType

public EventTypeCreator withExceptionType(org.palladiosimulator.pcm.repository.ExceptionType exceptionType)

Adds the exceptionType to the event type'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 event type in the making

See Also:

FluentRepositoryFactory.fetchOfExceptionType(String)

build

protected org.palladiosimulator.pcm.repository.EventType build()

Description copied from class: Entity

Turns the entity in the making into the finished entity.

Specified by:

build in class Entity

Returns:

the finished entity