com.nomagic.magicdraw.patterns

Class PatternsManager

java.lang.Object

com.nomagic.magicdraw.patterns.PatternsManager

@OpenApiAll
public final class PatternsManager
extends java.lang.Object

PatternsManager organizes process of design pattern application. It creates Wizard, gets selected pattern, properties and applies design pattern This class is responsible for Undo/redo commands etc. Use this class as singleton.

Method Summary

Modifier and Type	Method and Description
void	addPattern(PatternInfo info) Adds the given pattern in registered patterns collection.
boolean	applyPattern(Target target) The method starts applying design pattern, i.e.
boolean	applyPattern(Target target, java.util.Collection patterns) The method starts applying design pattern, i.e.
boolean	applyPattern(Target target, java.lang.String categoryName) Applies design pattern.
static PatternsManager	getInstance() Returns a shared instance of patterns manager.
java.util.Collection	getPatterns() Returns all registered patterns.
void	removePattern(PatternInfo info) Removes the given pattern from registered patterns collection.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static PatternsManager getInstance()

Returns a shared instance of patterns manager.

Returns:

instance of patterns manager.

addPattern

public void addPattern(PatternInfo info)

Adds the given pattern in registered patterns collection.

Parameters:

info - the give pattern to add.

removePattern

public void removePattern(PatternInfo info)

Removes the given pattern from registered patterns collection.

Parameters:

info - the given pattern to remove.

getPatterns

public java.util.Collection getPatterns()

Returns all registered patterns.

Returns:

a collection of registered patterns.

applyPattern

public boolean applyPattern(Target target,
                            java.lang.String categoryName)

Applies design pattern. Sets target for wizard, opens wizard window, gets pattern command, properties and applies pattern. The method is responsible for tasks like undo/redo etc. Only patterns from given category name will be shown.

Parameters:

target - pattern target

categoryName - name of category from which patterns will be shown.

Returns:

true if pattern was applied.

applyPattern

public boolean applyPattern(Target target)

The method starts applying design pattern, i.e. sets target for wizard, opens wizard window, gets pattern command, properties and applies pattern. The method is responsible for tasks like undo/redo etc.

Parameters:

target - pattern target

Returns:

true if pattern was applied.

applyPattern

public boolean applyPattern(Target target,
                            java.util.Collection patterns)

The method starts applying design pattern, i.e. sets target for wizard, opens wizard window, gets pattern command, properties and applies pattern. The method is responsible for tasks like undo/redo etc.

Parameters:

target - pattern target

patterns - pattern to select from

Returns:

true if pattern was applied.