com.nomagic.magicdraw.patterns

Class PatternInfo

java.lang.Object

com.nomagic.magicdraw.patterns.PatternInfo

@OpenApiAll
public class PatternInfo
extends java.lang.Object

The class encloses information about the pattern, i.e. panel container, rules for application of the pattern.

See Also:

AbstractPanelContainer, AbstractPattern

Constructor Summary

Constructors

Constructor and Description
PatternInfo(AbstractPattern pattern, AbstractPanelContainer panel, AbstractPatternProperties properties, java.lang.String descriptionResource) The info class used to describe one pattern.

Method Summary

Modifier and Type	Method and Description
void	configureForTarget(Target target) Sets target, the design pattern is being applied to
java.io.InputStream	getDescriptionAsStream() The method returns input stream in order to read pattern description
AbstractPanelContainer	getPanelContainer() Returns panel container for the certain pattern.
AbstractPattern	getPattern() Returns pattern implementation object.
java.lang.String	getPatternName() Returns the name of a pattern(not categorized).
AbstractPatternProperties	getPatternProperties() Returns pattern properties for a pattern.

Methods inherited from class java.lang.Object

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

Constructor Detail

PatternInfo

public PatternInfo(AbstractPattern pattern,
                   AbstractPanelContainer panel,
                   AbstractPatternProperties properties,
                   java.lang.String descriptionResource)

The info class used to describe one pattern.

Parameters:

pattern - the pattern class.

panel - the pattern panels.

properties - the pattern properties.

descriptionResource - the description resource string(the syntax must be the same as for pattern.getClass().getResourceAsStream().

Method Detail

getPattern

public AbstractPattern getPattern()

Returns pattern implementation object.

Returns:

Pattern implementation object.

getPanelContainer

public AbstractPanelContainer getPanelContainer()

Returns panel container for the certain pattern.

Returns:

panel container.

getPatternProperties

public AbstractPatternProperties getPatternProperties()

Returns pattern properties for a pattern.

Returns:

pattern properties.

getDescriptionAsStream

public java.io.InputStream getDescriptionAsStream()

The method returns input stream in order to read pattern description

Returns:

input stream of pattern description.

configureForTarget

public void configureForTarget(Target target)

Sets target, the design pattern is being applied to

Parameters:

target - the given target.

getPatternName

public java.lang.String getPatternName()

Returns the name of a pattern(not categorized).

Returns:

pattern name.