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

Class Interface

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

Direct Known Subclasses:

EventGroupCreator, InfrastructureInterfaceCreator, OperationInterfaceCreator

public abstract class Interface
extends RepositoryEntity

This class provides the general infrastructure of an interface, i.e. OperationInterface, InfrastructureInterface and EventGroup. It provides the implementation of the methods for adding parent interfaces and providing required characterizations.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<org.palladiosimulator.pcm.repository.Interface>	parentInterfaces
protected List<org.palladiosimulator.pcm.repository.RequiredCharacterisation>	requiredCharacterisations

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
Interface()

Method Summary

Modifier and Type	Method	Description
abstract org.palladiosimulator.pcm.repository.Interface	build()	Turns the entity in the making into the finished entity.
Interface	conforms(org.palladiosimulator.pcm.repository.Interface parentInterface)	Creates a conforming (parental) connection to the parentInterface and adds it to this interface/event group.
Interface	withRequiredCharacterisation(org.palladiosimulator.pcm.repository.Parameter parameter, org.palladiosimulator.pcm.parameter.VariableCharacterisationType type)	Creates a RequiredCharacterisation and adds it to the interface/event group.

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

withName

Methods inherited from class java.lang.Object

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

Field Detail

parentInterfaces

protected List<org.palladiosimulator.pcm.repository.Interface> parentInterfaces

requiredCharacterisations

protected List<org.palladiosimulator.pcm.repository.RequiredCharacterisation> requiredCharacterisations

Constructor Detail

Interface

public Interface()

Method Detail

build

public abstract org.palladiosimulator.pcm.repository.Interface 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

conforms

public Interface conforms(org.palladiosimulator.pcm.repository.Interface parentInterface)

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).

Parameters:

parentInterface -

Returns:

this interface/event group in the making

See Also:

FluentRepositoryFactory.fetchOfInterface(String), Interface.getParentInterfaces__Interface(), Interface

withRequiredCharacterisation

public Interface withRequiredCharacterisation(org.palladiosimulator.pcm.repository.Parameter parameter,
                                              org.palladiosimulator.pcm.parameter.VariableCharacterisationType type)

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).

Parameters:

parameter - that is specified

type - of the parameter

Returns:

this interface/event group in the making

See Also:

FluentRepositoryFactory.fetchOfParameter(String), FluentRepositoryFactory.fetchOfParameter(String, org.palladiosimulator.pcm.repository.Signature)