com.nomagic.magicdraw.patterns

Class AbstractPattern

java.lang.Object

com.nomagic.magicdraw.patterns.AbstractPattern

@OpenApiAll
public abstract class AbstractPattern
extends java.lang.Object

This is the base class for all patterns.

Constructor Summary

Constructors

Constructor and Description
AbstractPattern()

Method Summary

Modifier and Type	Method and Description
abstract void	applyPattern(Target target, AbstractPatternProperties prop) Applies design pattern to the target, using properties, passed as an argument.
boolean	canBeApplied(Target target) Checks if this pattern can be applied to the given target.
abstract java.lang.String[]	getCategorizedName() Returns the categorized name of the pattern.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPattern

public AbstractPattern()

Method Detail

getCategorizedName

public abstract java.lang.String[] getCategorizedName()

Returns the categorized name of the pattern. First element in array is category name, second pattern name. For example {"GOF", "Observer"}.

Returns:

name of the pattern.

applyPattern

public abstract void applyPattern(Target target,
                                  AbstractPatternProperties prop)
                           throws ReadOnlyElementException

Applies design pattern to the target, using properties, passed as an argument.

Parameters:

target - Target, the pattern is applied for.

prop - the pattern properties.

Throws:

ReadOnlyElementException

canBeApplied

public boolean canBeApplied(Target target)

Checks if this pattern can be applied to the given target. Default implementation here returns true always. You can override this method and return true only for example if target is Interface or ModelClass.

Returns:

true, if this pattern can be applied to the given target.