SmartListenerConfig

java.lang.Object
- com.nomagic.uml2.ext.jmi.smartlistener.SmartListenerConfig

```
@OpenApiAll
public class SmartListenerConfig
extends java.lang.Object
```
Smart listener configuration describes how to reach a specific property in the model from a given model element. Smart listener uses the configuration to create a chain of properties through which listener events map.

This class also contains predefined smart listener configurations which can be widely reused. Reusable smart listener configurations cannot be modified.

See Also:

SmartPropertyChangeListener, BaseElement.addPropertyChangeListener(java.beans.PropertyChangeListener)

Field Summary

Fields
Modifier and Type	Field and Description
`static SmartListenerConfig`	`APPLIED_STEREOTYPE_CONFIG` Listen to the applied stereotype instance.
`static SmartListenerConfig`	`COMBINED_FRAGMENT_CONFIG` Listens to combined fragment.
`static SmartListenerConfig`	`CONVEYED_INFORMATION_CONFIG` Listens to conveyed information.
`static SmartListenerConfig`	`DIAGRAM_CONTEXT_CONFIG` Listens to diagram context.
`static SmartListenerConfig`	`INSTANCE_SLOT_VALUE_CONFIG` Listen to the slot value of the applied stereotype instance.
`static SmartListenerConfig`	`INSTANCE_SPECIFICATION_CLASSIFIER_CONFIG` Listens to instance specification classifier.
`static SmartListenerConfig`	`MESSAGE_CONFIG` Listens to the message.
`static SmartListenerConfig`	`MESSAGE_SIGNATURE_CONFIG` Listens to message signature.
`static SmartListenerConfig`	`MULTIPLICITY_CONFIG` Listens to the multiplicity.
`static SmartListenerConfig`	`NAME_CONFIG` Listen to the name of the element.
`static SmartListenerConfig`	`PARAMETER_SUBSTITUTION_CONFIG` Listens to parameter substitution.
`static SmartListenerConfig`	`QUALIFIED_NAME_CONFIG` Listen to the qualified name of the element.
`static SmartListenerConfig`	`SLOT_VALUE_CONFIG` Listen to the value of the slot.
`static SmartListenerConfig`	`STEREOTYPE_AND_QNAME_CONFIG` Listen to the stereotype and qualified name.
`static SmartListenerConfig`	`STEREOTYPE_AND_TAGS_CONFIG` Listens to stereotypes and tag values.
`static SmartListenerConfig`	`STEREOTYPE_AND_TAGS_INSTANCE_SPECIFICATION_CONFIG` Listens to stereotype and tags for applied instance specification.
`static SmartListenerConfig`	`STEREOTYPE_CONFIG` Listen to the applied stereotype.
`static SmartListenerConfig`	`STEREOTYPE_INSTANCE_SPECIFICATION_CONFIG` Listens to instance specification stereotype.
`static SmartListenerConfig`	`STEREOTYPE_METACLASS_CONFIG` Listen to the metaclass of a stereotype.
`static SmartListenerConfig`	`TRANSITION_CONFIG` Listens to transition.
`static SmartListenerConfig`	`TRIGGER_CONFIG` Listens to trigger.
`static SmartListenerConfig`	`VALUE_SPECIFICATION_CONFIG` Listen to the value specification.

Constructor Summary

Constructors
Constructor and Description
`SmartListenerConfig()` Constructs the configuration.
`SmartListenerConfig(java.util.Map<java.lang.String,SmartListenerConfig> references)` Constructs smart listener config.
`SmartListenerConfig(java.lang.String propertyName)` Constructs the configuration with a property name.
`SmartListenerConfig(java.lang.String propertyName, SmartListenerConfig config)` Constructs the configuration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`copy(SmartListenerConfig config)` Makes a shallow copy of the passed config to this config.
`static SmartListenerConfig`	`createBehaviorsConfig()` Creates a smart listener config for listening to owned behaviors in the classifier hierarchy.
`static SmartListenerConfig`	`createEventConfig()` Creates event config.
`static SmartListenerConfig`	`createMessageSignature()` Creates listener for message signature.
`static SmartListenerConfig`	`createSignalConfig()` Creates signal config.
`void`	`deepCopy(SmartListenerConfig config)` Deep copies a passed config to this config.
`void`	`dump()` Dumps property configuration to the standard output.
`SmartListenerConfig`	`getPropertyConfig(java.lang.String propertyName)` Gets property config which is used for a particular property.
`java.util.Map<java.lang.String,SmartListenerConfig>`	`getReferences()` Gets references of this configuration.
`static void`	`initStereotypeAndTagsInstanceSpecificationConfig(SmartListenerConfig stereotypeAndTagsInstanceSpecificationConfig, SmartListenerConfig slotConfig)` Initializes stereotypes and tags instance specification config.
`static void`	`initValueSpecificationConfig(SmartListenerConfig valueSpecificationConfig)` Initializes value specification config.
`static void`	`initValueSpecificationConfig(SmartListenerConfig valueSpecificationConfig, SmartListenerConfig elementConfig)` Initializes value specification config.
`SmartListenerConfig`	`listenTo(java.util.Collection propertyNames)` Listens to given property names.
`SmartListenerConfig`	`listenTo(java.lang.String propertyName)` Listens to a given property name.
`SmartListenerConfig`	`listenTo(java.lang.String referenceName, SmartListenerConfig config)` Listens to a given property and passes a smart listener configuration for it to apply if references are found among property values.
`SmartListenerConfig`	`listenTo2(java.lang.String referenceName, SmartListenerConfig config)` Deprecated. use `listenTo(String, SmartListenerConfig)`, because it merges configs too.
`SmartListenerConfig`	`listenToNested(java.lang.String propertyName)` Listens to a nested property configuration.
`void`	`makeUnmodifiable()` Make config unmodifiable.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NAME_CONFIG
```
public static final SmartListenerConfig NAME_CONFIG
```
    Listen to the name of the element.
  - QUALIFIED_NAME_CONFIG
```
public static final SmartListenerConfig QUALIFIED_NAME_CONFIG
```
    Listen to the qualified name of the element.
  - VALUE_SPECIFICATION_CONFIG
```
public static final SmartListenerConfig VALUE_SPECIFICATION_CONFIG
```
    Listen to the value specification.
  - SLOT_VALUE_CONFIG
```
public static final SmartListenerConfig SLOT_VALUE_CONFIG
```
    Listen to the value of the slot.
  - INSTANCE_SLOT_VALUE_CONFIG
```
public static final SmartListenerConfig INSTANCE_SLOT_VALUE_CONFIG
```
    Listen to the slot value of the applied stereotype instance.
  - APPLIED_STEREOTYPE_CONFIG
```
public static final SmartListenerConfig APPLIED_STEREOTYPE_CONFIG
```
    Listen to the applied stereotype instance.
  - STEREOTYPE_METACLASS_CONFIG
```
public static final SmartListenerConfig STEREOTYPE_METACLASS_CONFIG
```
    Listen to the metaclass of a stereotype.
  - STEREOTYPE_CONFIG
```
public static final SmartListenerConfig STEREOTYPE_CONFIG
```
    Listen to the applied stereotype.
  - STEREOTYPE_AND_QNAME_CONFIG
```
public static SmartListenerConfig STEREOTYPE_AND_QNAME_CONFIG
```
    Listen to the stereotype and qualified name.
  - STEREOTYPE_AND_TAGS_CONFIG
```
public static final SmartListenerConfig STEREOTYPE_AND_TAGS_CONFIG
```
    Listens to stereotypes and tag values.
  - PARAMETER_SUBSTITUTION_CONFIG
```
public static final SmartListenerConfig PARAMETER_SUBSTITUTION_CONFIG
```
    Listens to parameter substitution.
  - TRIGGER_CONFIG
```
public static final SmartListenerConfig TRIGGER_CONFIG
```
    Listens to trigger.
  - TRANSITION_CONFIG
```
public static final SmartListenerConfig TRANSITION_CONFIG
```
    Listens to transition.
  - MESSAGE_SIGNATURE_CONFIG
```
public static SmartListenerConfig MESSAGE_SIGNATURE_CONFIG
```
    Listens to message signature.
  - MESSAGE_CONFIG
```
public static final SmartListenerConfig MESSAGE_CONFIG
```
    Listens to the message.
  - COMBINED_FRAGMENT_CONFIG
```
public static final SmartListenerConfig COMBINED_FRAGMENT_CONFIG
```
    Listens to combined fragment.
  - CONVEYED_INFORMATION_CONFIG
```
public static final SmartListenerConfig CONVEYED_INFORMATION_CONFIG
```
    Listens to conveyed information.
  - STEREOTYPE_AND_TAGS_INSTANCE_SPECIFICATION_CONFIG
```
public static final SmartListenerConfig STEREOTYPE_AND_TAGS_INSTANCE_SPECIFICATION_CONFIG
```
    Listens to stereotype and tags for applied instance specification.
  - DIAGRAM_CONTEXT_CONFIG
```
public static final SmartListenerConfig DIAGRAM_CONTEXT_CONFIG
```
    Listens to diagram context.
  - MULTIPLICITY_CONFIG
```
public static final SmartListenerConfig MULTIPLICITY_CONFIG
```
    Listens to the multiplicity.
  - STEREOTYPE_INSTANCE_SPECIFICATION_CONFIG
```
public static final SmartListenerConfig STEREOTYPE_INSTANCE_SPECIFICATION_CONFIG
```
    Listens to instance specification stereotype.
  - INSTANCE_SPECIFICATION_CLASSIFIER_CONFIG
```
public static final SmartListenerConfig INSTANCE_SPECIFICATION_CLASSIFIER_CONFIG
```
    Listens to instance specification classifier.
- Constructor Detail
  - SmartListenerConfig
```
public SmartListenerConfig()
```
    Constructs the configuration.
  - SmartListenerConfig
```
public SmartListenerConfig(java.lang.String propertyName)
```
    Constructs the configuration with a property name.
    
    Parameters:
    
    propertyName - property name to use as a reference.
  - SmartListenerConfig
```
public SmartListenerConfig(java.lang.String propertyName,
                           SmartListenerConfig config)
```
    Constructs the configuration.
    
    Parameters:
    
    propertyName - property name to use as a reference.
    
    config - config to use with a property reference.
  - SmartListenerConfig
```
public SmartListenerConfig(java.util.Map<java.lang.String,SmartListenerConfig> references)
```
    Constructs smart listener config.
    
    Parameters:
    
    references - references to use.
- Method Detail
  - initStereotypeAndTagsInstanceSpecificationConfig
```
public static void initStereotypeAndTagsInstanceSpecificationConfig(SmartListenerConfig stereotypeAndTagsInstanceSpecificationConfig,
                                                                    SmartListenerConfig slotConfig)
```
    Initializes stereotypes and tags instance specification config.
    
    Parameters:
    
    stereotypeAndTagsInstanceSpecificationConfig - config to initialize.
    
    slotConfig - slot config with which to initialize.
  - initValueSpecificationConfig
```
public static void initValueSpecificationConfig(SmartListenerConfig valueSpecificationConfig)
```
    Initializes value specification config.
    
    Parameters:
    
    valueSpecificationConfig - config to initialize.
  - initValueSpecificationConfig
```
public static void initValueSpecificationConfig(SmartListenerConfig valueSpecificationConfig,
                                                SmartListenerConfig elementConfig)
```
    Initializes value specification config.
    
    Parameters:
    
    valueSpecificationConfig - config to initialize.
    
    elementConfig - element config to use.
  - createEventConfig
```
public static SmartListenerConfig createEventConfig()
```
    Creates event config.
    
    Returns:
    
    created config.
  - createSignalConfig
```
public static SmartListenerConfig createSignalConfig()
```
    Creates signal config.
    
    Returns:
    
    created signal config.
  - createMessageSignature
```
public static SmartListenerConfig createMessageSignature()
```
    Creates listener for message signature. Can be passed additional configurator, if complex recursive configuration is needed.
  - createBehaviorsConfig
```
public static SmartListenerConfig createBehaviorsConfig()
```
    Creates a smart listener config for listening to owned behaviors in the classifier hierarchy.
    
    Returns:
    
    created smart listener config.
  - makeUnmodifiable
```
public void makeUnmodifiable()
```
    Make config unmodifiable. This means that new references can not be added or existing can not be changed. Any attempt to change unmodifiable config will end up with runtime exception.
  - copy
```
public void copy(SmartListenerConfig config)
```
    Makes a shallow copy of the passed config to this config. Instances of configs in the tree are reused and not re-created.
    
    Parameters:
    
    config - passed configuration for copying.
  - deepCopy
```
public void deepCopy(SmartListenerConfig config)
```
    Deep copies a passed config to this config. Whole config tree is copied by recreating referenced config instances.
    
    Parameters:
    
    config - config to copy.
  - getReferences
```
public java.util.Map<java.lang.String,SmartListenerConfig> getReferences()
```
    Gets references of this configuration.
    
    Returns:
    
    references of this configuration.
  - getPropertyConfig
```
public SmartListenerConfig getPropertyConfig(java.lang.String propertyName)
```
    Gets property config which is used for a particular property.
    
    Parameters:
    
    propertyName - property for which to get property config.
    
    Returns:
    
    property config for a given property.
  - listenTo
```
public SmartListenerConfig listenTo(java.lang.String referenceName,
                                    @CheckForNull
                                    SmartListenerConfig config)
```
    Listens to a given property and passes a smart listener configuration for it to apply if references are found among property values.
    
    Parameters:
    
    referenceName - property name for which configuration should be applied.
    
    config - passed configuration for the property. If for a given property an existing configuration is found, the two configurations will be merged and the merged configuration will be stored.
    
    Returns:
    
    this config or a merged config if the configurations had to be merged.
  - listenTo2
```
@Deprecated
public SmartListenerConfig listenTo2(java.lang.String referenceName,
                                                 SmartListenerConfig config)
```
    Deprecated. use listenTo(String, SmartListenerConfig), because it merges configs too.
    
    Makes the same thing as listenTo(String, SmartListenerConfig). Only if founds already registered property doesn't emit warning, but makes merge with already registered configuration. If configurations are merged, then passed config VALUE is replaced with a contents of merge result.
    
    Parameters:
    
    referenceName - property name for which configuration is applicable
    
    config - passed configuration. It's VALUE will be edited if another configuration will be found already registered by given reference name. VALUE of passed reference will be changed to the merged one
    
    Returns:
    
    this config
  - listenTo
```
public SmartListenerConfig listenTo(java.lang.String propertyName)
```
    Listens to a given property name.
    
    Parameters:
    
    propertyName - property name ot listen to.
    
    Returns:
    
    this property config or a merged property configuration.
  - listenTo
```
public SmartListenerConfig listenTo(java.util.Collection propertyNames)
```
    Listens to given property names.
    
    Parameters:
    
    propertyNames - property names to listen to.
    
    Returns:
    
    this property config or a merged property configuration.
  - listenToNested
```
public SmartListenerConfig listenToNested(java.lang.String propertyName)
```
    Listens to a nested property configuration.
    
    Parameters:
    
    propertyName - property name to listen to.
    
    Returns:
    
    property config of a given property, allows to perform nested calls.
  - dump
```
public void dump()
```
    Dumps property configuration to the standard output.

Class SmartListenerConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAME_CONFIG

QUALIFIED_NAME_CONFIG

VALUE_SPECIFICATION_CONFIG

SLOT_VALUE_CONFIG

INSTANCE_SLOT_VALUE_CONFIG

APPLIED_STEREOTYPE_CONFIG

STEREOTYPE_METACLASS_CONFIG

STEREOTYPE_CONFIG

STEREOTYPE_AND_QNAME_CONFIG

STEREOTYPE_AND_TAGS_CONFIG

PARAMETER_SUBSTITUTION_CONFIG

TRIGGER_CONFIG

TRANSITION_CONFIG

MESSAGE_SIGNATURE_CONFIG

MESSAGE_CONFIG

COMBINED_FRAGMENT_CONFIG

CONVEYED_INFORMATION_CONFIG

STEREOTYPE_AND_TAGS_INSTANCE_SPECIFICATION_CONFIG

DIAGRAM_CONTEXT_CONFIG

MULTIPLICITY_CONFIG

STEREOTYPE_INSTANCE_SPECIFICATION_CONFIG

INSTANCE_SPECIFICATION_CLASSIFIER_CONFIG

Constructor Detail

SmartListenerConfig

SmartListenerConfig

SmartListenerConfig

SmartListenerConfig

Method Detail

initStereotypeAndTagsInstanceSpecificationConfig

initValueSpecificationConfig

initValueSpecificationConfig

createEventConfig

createSignalConfig

createMessageSignature

createBehaviorsConfig

makeUnmodifiable

copy

deepCopy

getReferences

getPropertyConfig

listenTo

listenTo2

listenTo

listenTo

listenToNested

dump