org.eclipse.etrice.core.room.util
Class RoomHelpers

java.lang.Object
  org.eclipse.etrice.core.room.util.RoomHelpers

public class RoomHelpers
extends java.lang.Object

description

Author:

Henrik Rentz-Reichert initial contribution and API

Constructor Summary

RoomHelpers()

Method Summary

static ActorClass	getActorClass(EObject obj)
static ActorClass	getActorClass(StateGraphItem item)
static java.util.List<Attribute>	getAllAttributes(ActorClass ac)
static java.util.Set<java.lang.String>	getAllChoicePointNames(StateGraph sg)
static java.util.Set<java.lang.String>	getAllChoicePointNames(StateGraph sg, ChoicePoint skip)
static java.util.List<ChoicePoint>	getAllChoicePoints(StateGraph sg)
static java.util.List<Port>	getAllEndPorts(ActorClass ac)
static java.util.List<InterfaceItem>	getAllInterfaceItems(ActorClass ac)
static java.util.Set<java.lang.String>	getAllNames(StateGraph sg)
static java.util.Set<java.lang.String>	getAllNames(StateGraph sg, StateGraphItem skip)
static java.util.List<Operation>	getAllOperations(ActorClass ac)
static java.util.Set<java.lang.String>	getAllStateNames(StateGraph sg)
static java.util.Set<java.lang.String>	getAllStateNames(StateGraph sg, State skip)
static java.util.List<State>	getAllStates(StateGraph sg)
static java.util.List<State>	getAllStateTrees(StateGraph sg)
static java.util.Set<java.lang.String>	getAllTransitionNames(StateGraph sg)
static java.util.Set<java.lang.String>	getAllTransitionNames(StateGraph sg, Transition skip)
static java.util.List<Transition>	getAllTransitions(StateGraph sg)
static java.util.Set<java.lang.String>	getAllTrPointNames(StateGraph sg)
static java.util.Set<java.lang.String>	getAllTrPointNames(StateGraph sg, TrPoint skip)
static java.util.List<TrPoint>	getAllTrPoints(StateGraph sg)
static java.lang.String	getArguments(Operation op)
static java.lang.String	getAttribute(ActorClass ac, java.lang.String name, java.lang.String key)
static java.lang.String	getAttribute(Annotation annotation, java.lang.String key)
static java.lang.String	getAttribute(java.util.List<Annotation> annotations, java.lang.String name, java.lang.String key)
static java.util.List<KeyValue>	getAttributes(ActorClass ac, java.lang.String name)
static java.util.List<KeyValue>	getAttributes(java.util.List<Annotation> annotations, java.lang.String name)
static SimpleState	getBaseState(State s) return the BaseState of a State
static java.util.List<Binding>	getBindings(StructureClass sc, boolean includeInherited)
static java.util.List<LayerConnection>	getConnections(StructureClass sc, boolean includeInherited)
static java.util.List<EObject>	getContainedObjects(StructureClass sc)
static java.lang.String	getDetailCode(DetailCode dc)
static java.util.List<InterfaceItem>	getInterfaceItems(StructureClass sc, boolean includeInherited)
static java.util.List<Message>	getMessageList(InterfaceItem item, boolean outgoing)
static PortClass	getPortClass(InterfaceItem item)
static ProtocolClass	getProtocolClass(EObject obj) first container of type ProtocolClass
static java.util.List<State>	getReferencedStatesRecursively(RefinedState rs)
static State	getRefinedStateFor(StateGraph sg, State state) The default resolution mechanism will return a SimpleState.
static java.util.Map<RefinedState,RefinedState>	getRefinedStatesToRelocate(ActorClass ac)
static java.util.List<ActorContainerRef>	getRefs(StructureClass sc, boolean includeInherited)
static java.lang.String	getSignature(Operation op)
static State	getTargettingState(State state, ActorClass ac)
static boolean	hasConstructor(ActorClass ac)
static boolean	hasDestructor(ActorClass ac)
static boolean	hasDetailCode(DetailCode dc)
static boolean	hasDirectSubStructure(State s)
static boolean	hasFlatStateMachine(ActorClass ac)
static boolean	hasNonEmptyStateMachine(ActorClass ac)
static boolean	hasSubStructure(State state, ActorClass ac)
static boolean	isAnnotationPresent(ActorClass ac, java.lang.String name)
static boolean	isAnnotationPresent(java.util.List<Annotation> annotations, java.lang.String name)
static boolean	isAttributePresent(ActorClass ac, java.lang.String name, java.lang.String key)
static boolean	isAttributePresent(Annotation annotation, java.lang.String key)
static boolean	isAttributePresent(java.util.List<Annotation> annotations, java.lang.String name, java.lang.String key)
static boolean	isConstructor(Operation op)
static boolean	isDestructor(Operation op)
static boolean	isGuarded(Trigger trig)
static boolean	referencesStateRecursively(RefinedState rs, State referenced)

Methods inherited from class java.lang.Object

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

Constructor Detail

RoomHelpers

public RoomHelpers()

Method Detail

getInterfaceItems

public static java.util.List<InterfaceItem> getInterfaceItems(StructureClass sc,
                                                              boolean includeInherited)

getRefs

public static java.util.List<ActorContainerRef> getRefs(StructureClass sc,
                                                        boolean includeInherited)

getBindings

public static java.util.List<Binding> getBindings(StructureClass sc,
                                                  boolean includeInherited)

getConnections

public static java.util.List<LayerConnection> getConnections(StructureClass sc,
                                                             boolean includeInherited)

getContainedObjects

public static java.util.List<EObject> getContainedObjects(StructureClass sc)

hasSubStructure

public static boolean hasSubStructure(State state,
                                      ActorClass ac)

hasDirectSubStructure

public static boolean hasDirectSubStructure(State s)

hasNonEmptyStateMachine

public static boolean hasNonEmptyStateMachine(ActorClass ac)

getTargettingState

public static State getTargettingState(State state,
                                       ActorClass ac)

Parameters:

state -

ac -

Returns:

hasDetailCode

public static boolean hasDetailCode(DetailCode dc)

getDetailCode

public static java.lang.String getDetailCode(DetailCode dc)

Parameters:

action -

Returns:

getRefinedStateFor

public static State getRefinedStateFor(StateGraph sg,
                                       State state)

The default resolution mechanism will return a SimpleState. This methods searches for RefinedStates targeting the simple state.

Parameters:

sg - the context for the search

state - the target state

Returns:

a refined state targeting state or state itself

isGuarded

public static boolean isGuarded(Trigger trig)

getAllStates

public static java.util.List<State> getAllStates(StateGraph sg)

getAllStateTrees

public static java.util.List<State> getAllStateTrees(StateGraph sg)

getAllTrPoints

public static java.util.List<TrPoint> getAllTrPoints(StateGraph sg)

getAllChoicePoints

public static java.util.List<ChoicePoint> getAllChoicePoints(StateGraph sg)

getAllTransitions

public static java.util.List<Transition> getAllTransitions(StateGraph sg)

getAllNames

public static java.util.Set<java.lang.String> getAllNames(StateGraph sg)

getAllNames

public static java.util.Set<java.lang.String> getAllNames(StateGraph sg,
                                                          StateGraphItem skip)

getAllStateNames

public static java.util.Set<java.lang.String> getAllStateNames(StateGraph sg)

getAllStateNames

public static java.util.Set<java.lang.String> getAllStateNames(StateGraph sg,
                                                               State skip)

getAllTrPointNames

public static java.util.Set<java.lang.String> getAllTrPointNames(StateGraph sg)

getAllTrPointNames

public static java.util.Set<java.lang.String> getAllTrPointNames(StateGraph sg,
                                                                 TrPoint skip)

getAllChoicePointNames

public static java.util.Set<java.lang.String> getAllChoicePointNames(StateGraph sg)

getAllChoicePointNames

public static java.util.Set<java.lang.String> getAllChoicePointNames(StateGraph sg,
                                                                     ChoicePoint skip)

getAllTransitionNames

public static java.util.Set<java.lang.String> getAllTransitionNames(StateGraph sg)

getAllTransitionNames

public static java.util.Set<java.lang.String> getAllTransitionNames(StateGraph sg,
                                                                    Transition skip)

getAllAttributes

public static java.util.List<Attribute> getAllAttributes(ActorClass ac)

getAllOperations

public static java.util.List<Operation> getAllOperations(ActorClass ac)

getAllEndPorts

public static java.util.List<Port> getAllEndPorts(ActorClass ac)

getAllInterfaceItems

public static java.util.List<InterfaceItem> getAllInterfaceItems(ActorClass ac)

getActorClass

public static ActorClass getActorClass(StateGraphItem item)

getActorClass

public static ActorClass getActorClass(EObject obj)

getProtocolClass

public static ProtocolClass getProtocolClass(EObject obj)

first container of type ProtocolClass

Parameters:

obj -

Returns:

ActorClass container

isAnnotationPresent

public static boolean isAnnotationPresent(ActorClass ac,
                                          java.lang.String name)

isAnnotationPresent

public static boolean isAnnotationPresent(java.util.List<Annotation> annotations,
                                          java.lang.String name)

getAttributes

public static java.util.List<KeyValue> getAttributes(ActorClass ac,
                                                     java.lang.String name)

getAttributes

public static java.util.List<KeyValue> getAttributes(java.util.List<Annotation> annotations,
                                                     java.lang.String name)

isAttributePresent

public static boolean isAttributePresent(ActorClass ac,
                                         java.lang.String name,
                                         java.lang.String key)

isAttributePresent

public static boolean isAttributePresent(java.util.List<Annotation> annotations,
                                         java.lang.String name,
                                         java.lang.String key)

getAttribute

public static java.lang.String getAttribute(ActorClass ac,
                                            java.lang.String name,
                                            java.lang.String key)

getAttribute

public static java.lang.String getAttribute(java.util.List<Annotation> annotations,
                                            java.lang.String name,
                                            java.lang.String key)

isAttributePresent

public static boolean isAttributePresent(Annotation annotation,
                                         java.lang.String key)

getAttribute

public static java.lang.String getAttribute(Annotation annotation,
                                            java.lang.String key)

hasFlatStateMachine

public static boolean hasFlatStateMachine(ActorClass ac)

getMessageList

public static java.util.List<Message> getMessageList(InterfaceItem item,
                                                     boolean outgoing)

getPortClass

public static PortClass getPortClass(InterfaceItem item)

isConstructor

public static boolean isConstructor(Operation op)

isDestructor

public static boolean isDestructor(Operation op)

getSignature

public static java.lang.String getSignature(Operation op)

getArguments

public static java.lang.String getArguments(Operation op)

getBaseState

public static SimpleState getBaseState(State s)

return the BaseState of a State

Parameters:

s -

Returns:

the state itself if a BaseState or the BaseState for a RefinedState

getReferencedStatesRecursively

public static java.util.List<State> getReferencedStatesRecursively(RefinedState rs)

hasConstructor

public static boolean hasConstructor(ActorClass ac)

hasDestructor

public static boolean hasDestructor(ActorClass ac)

referencesStateRecursively

public static boolean referencesStateRecursively(RefinedState rs,
                                                 State referenced)

getRefinedStatesToRelocate

public static java.util.Map<RefinedState,RefinedState> getRefinedStatesToRelocate(ActorClass ac)

Parameters:

ac -

Returns: