com.nomagic.uml2.ext.jmi.helpers

Class StereotypePropertyValueProvider

java.lang.Object

com.nomagic.uml2.ext.jmi.helpers.StereotypePropertyValueProvider

@OpenApiAll
public class StereotypePropertyValueProvider
extends java.lang.Object

Class aggregates instances of PropertyValueCalculator type. It doesn't provide any functionality by itself. It's supposed to be used by StereotypesHelper class. See StereotypesHelper.getStereotypePropertyValue(Element, Stereotype, String, boolean) for details. Clients (plugins most likely) can register their own PropertyValueCalculator instances. There is only one PropertyValueCalculator instance allowed for one stereotype and stereotype property pair.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StereotypePropertyValueProvider.PropertyValueCalculator Interface to provide a way for plugins to override tagged values visualization.

Constructor Summary

Constructors

Constructor and Description
StereotypePropertyValueProvider()

Method Summary

Modifier and Type	Method and Description
(package private) static boolean	canCalculateValue(Slot slot) Indicates if stereotype property value can be calculated.
(package private) static java.util.List	getCalculatedValue(Element element, Slot slot) Returns calculated property value if there is matching PropertyValueCalculator available.
static void	register(java.lang.String stereotypeName, java.lang.String propertyName, StereotypePropertyValueProvider.PropertyValueCalculator calc) Registers the calc to particular particular stereotype and stereotype property.
static void	unregister(java.lang.String stereotypeName, java.lang.String propertyName) Unregisters existing PropertyValueCalculator instance if there was previously registered to particular stereotype and stereotype property

Methods inherited from class java.lang.Object

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

Constructor Detail

StereotypePropertyValueProvider

public StereotypePropertyValueProvider()

Method Detail

unregister

public static void unregister(java.lang.String stereotypeName,
                              java.lang.String propertyName)

Unregisters existing PropertyValueCalculator instance if there was previously registered to particular stereotype and stereotype property

Parameters:

stereotypeName - name of the stereotype, can not be null

propertyName - name of the stereotype property, can not be null

register

public static void register(java.lang.String stereotypeName,
                            java.lang.String propertyName,
                            StereotypePropertyValueProvider.PropertyValueCalculator calc)

Registers the calc to particular particular stereotype and stereotype property.

Parameters:

stereotypeName - name of the stereotype, can not be null

propertyName - name of the stereotype property, can not be null

calc - PropertyValueCalculator instance, can not be null

getCalculatedValue

static java.util.List getCalculatedValue(Element element,
                                         Slot slot)

Returns calculated property value if there is matching PropertyValueCalculator available. It also check if the given slot is the value of stereotype property.

Parameters:

element - parent model element

slot - property value

Returns:

empty list if there is no matching PropertyValueCalculator or slot is not a value of stereotype property, otherwise calculated value.

canCalculateValue

static boolean canCalculateValue(Slot slot)

Indicates if stereotype property value can be calculated.

Parameters:

slot - property value

Returns:

true if there is matching PropertyValueCalculator available and slot is not null and slot is a value of stereotype property, otherwise false