com.nomagic.magicdraw.uml

Class DiagramType

java.lang.Object

com.nomagic.magicdraw.uml.DiagramType

All Implemented Interfaces:

DiagramTypeConstants, java.lang.Cloneable

@OpenApi
public class DiagramType
extends java.lang.Object
implements java.lang.Cloneable, DiagramTypeConstants

The DiagramType class represents the diagram type

Field Summary

Fields inherited from interface com.nomagic.magicdraw.uml.DiagramTypeConstants

CONTENT_DIAGRAM, DEPENDENCY_MATRIX, GENERIC_TABLE, GLOSSARY_TABLE, RELATION_MAP_DIAGRAM, UML_ACTIVITY_DIAGRAM, UML_ANY_DIAGRAM, UML_BEHAVIOR_DIAGRAM, UML_CLASS_DIAGRAM, UML_COMMUNICATION_DIAGRAM, UML_COMPONENT_DIAGRAM, UML_COMPOSITE_STRUCTURE_DIAGRAM, UML_DEPLOYMENT_DIAGRAM, UML_INTERACTION_DIAGRAM, UML_INTERACTION_OVERVIEW_DIAGRAM, UML_OBJECT_DIAGRAM, UML_PACKAGE_DIAGRAM, UML_PROFILE_DIAGRAM, UML_PROTOCOL_STATE_MACHINE_DIAGRAM, UML_SEQUENCE_DIAGRAM, UML_STATECHART_DIAGRAM, UML_STATIC_DIAGRAM, UML_USECASE_DIAGRAM, USER_INTERFACE_MODELING_DIAGRAM

Constructor Summary

Constructors

Constructor and Description
DiagramType(java.lang.String type) Constructs diagram type according given diagram type string representation.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
static DiagramType	createDiagramType(java.lang.String type) Creates diagram type of given type string representation.
static java.util.List<java.lang.String>	getAllDiagramTypes() Returns list of all diagram types.
static java.util.List<java.lang.String>	getCreatableDiagramTypes() Returns list of available to create (creatable) diagram types.
static DiagramType	getDiagramType(Diagram diagram) Return diagram type for a given diagram
java.lang.String	getRootType() Returns root type of this diagram type.
java.lang.String	getType() Returns the diagram type string representation
static boolean	isCreatableDiagramType(java.lang.String type) Check, whether diagram type is creatable.
boolean	isEqualType(DiagramType type) Checks if diagram type is equal to given diagram type.
boolean	isEqualType(java.lang.String type) Checks if diagram type is equal to given diagram type.
boolean	isTypeOf(DiagramType type) Checks if diagram type is of given diagram type (analogy of instanceof operator)
boolean	isTypeOf(java.util.List<java.lang.String> types) Checks if diagram type is of given diagram type (analogy of instanceof operator)
boolean	isTypeOf(java.lang.String type) Checks if diagram type is of given diagram type (analogy of instanceof operator)
void	setType(java.lang.String type) Sets the diagram type, according given diagram type string representation

Methods inherited from class java.lang.Object

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

Constructor Detail

DiagramType

@OpenApi
public DiagramType(java.lang.String type)

Constructs diagram type according given diagram type string representation.

Parameters:

type - diagram type string representation

See Also:

createDiagramType(String), DiagramTypeConstants, getAllDiagramTypes(), getCreatableDiagramTypes()

Method Detail

getDiagramType

@OpenApi
public static DiagramType getDiagramType(Diagram diagram)

Return diagram type for a given diagram

Parameters:

diagram - diagram

Returns:

diagram type

setType

@OpenApi
public void setType(java.lang.String type)

Sets the diagram type, according given diagram type string representation

Parameters:

type - diagram type string representation

See Also:

DiagramTypeConstants, getAllDiagramTypes(), getCreatableDiagramTypes()

getType

@OpenApi
public java.lang.String getType()

Returns the diagram type string representation

Returns:

diagram type string representation

See Also:

DiagramTypeConstants, getAllDiagramTypes()

isEqualType

@OpenApi
public boolean isEqualType(DiagramType type)

Checks if diagram type is equal to given diagram type.

Parameters:

type - diagram type

Returns:

true if this diagram type is equal to given diagram type; otherwise - false.

See Also:

isTypeOf(DiagramType)

isEqualType

@OpenApi
public boolean isEqualType(java.lang.String type)

Checks if diagram type is equal to given diagram type.

Parameters:

type - diagram type string representation

Returns:

true if this diagram type is equal to given diagram type; otherwise - false.

See Also:

DiagramTypeConstants, getAllDiagramTypes(), isTypeOf(String)

isTypeOf

@OpenApi
public boolean isTypeOf(DiagramType type)

Checks if diagram type is of given diagram type (analogy of instanceof operator)

Parameters:

type - diagram type.

Returns:

true if this diagram type is a 'subtype' of given diagram type or equal to given diagram type; otherwise - false.

See Also:

isTypeOf(String)

isTypeOf

@OpenApi
public boolean isTypeOf(java.util.List<java.lang.String> types)

Checks if diagram type is of given diagram type (analogy of instanceof operator)

Parameters:

types - the list of diagram type string representation.

Returns:

true if this diagram type is a 'subtype' of at least one given diagram type or equal to at least one given diagram type; othwerwise - false.

See Also:

DiagramTypeConstants, getAllDiagramTypes(), isTypeOf(DiagramType)

isTypeOf

@OpenApi
public boolean isTypeOf(java.lang.String type)

Checks if diagram type is of given diagram type (analogy of instanceof operator)

Parameters:

type - diagram type string representation.

Returns:

true if this diagram type is a 'subtype' of given diagram type or equal to given diagram type; otherwise - false.

See Also:

DiagramTypeConstants, getAllDiagramTypes(), isTypeOf(DiagramType)

getRootType

@OpenApi
public java.lang.String getRootType()

Returns root type of this diagram type.

Returns:

root type.

clone

@OpenApi
public java.lang.Object clone()
                                throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

getAllDiagramTypes

@OpenApi
public static java.util.List<java.lang.String> getAllDiagramTypes()

Returns list of all diagram types.

Returns:

list of all diagram types.

See Also:

getCreatableDiagramTypes()

getCreatableDiagramTypes

@OpenApi
public static java.util.List<java.lang.String> getCreatableDiagramTypes()

Returns list of available to create (creatable) diagram types.

Returns:

list of available to create (creatable) diagram types.

See Also:

getAllDiagramTypes()

createDiagramType

@OpenApi
public static DiagramType createDiagramType(java.lang.String type)

Creates diagram type of given type string representation.

Parameters:

type - diagram type string representation

Returns:

created diagram type.

See Also:

DiagramTypeConstants

isCreatableDiagramType

@OpenApi
public static boolean isCreatableDiagramType(java.lang.String type)

Check, whether diagram type is creatable.

Parameters:

type - diagram type string representation

Returns:

true, if type is creatable.

See Also:

DiagramTypeConstants