com.ibm.xtools.modeler.ui

Class UMLProfileUtility

java.lang.Object

com.ibm.xtools.modeler.ui.UMLProfileUtility

public class UMLProfileUtility
extends java.lang.Object

Provides utility methods for UML profiles.

Method Summary

Modifier and Type	Method and Description
static void	define(org.eclipse.uml2.uml.Profile profile) Defines the profile using the standard UML2 method, and applies custom extensions, like inserting version information.
static java.lang.String	getCategory(org.eclipse.uml2.uml.Stereotype stereotype) Queries a stereotype's localized category.
static byte[]	getIcon(org.eclipse.uml2.uml.Stereotype stereotype) Retrieves the binary data representing a stereotype's icon.
static byte[]	getShapeImage(org.eclipse.uml2.uml.Stereotype stereotype) Retrieves the binary data representing stereotype's shape image.
static boolean	isPropertiesUIReadOnly(org.eclipse.uml2.uml.Stereotype stereotype) Queries whether the specified stereotype's properties are UI Read Only.
static boolean	isSuppressed(org.eclipse.uml2.uml.Property property) Queries whether the specified stereotype property is suppressed.
static boolean	isSuppressed(org.eclipse.uml2.uml.Stereotype stereotype) Queries whether the specified stereotype is suppressed.
static boolean	isUIReadOnly(org.eclipse.uml2.uml.Property property) Queries whether the specified property is UI Read Only.
static boolean	isUIReadOnly(org.eclipse.uml2.uml.Stereotype stereotype) Queries whether the specified stereotype is UI Read Only.
static void	setCategory(org.eclipse.uml2.uml.Stereotype stereotype, java.lang.String category) Sets the stereotype's category.
static void	setIcon(org.eclipse.uml2.uml.Stereotype stereotype, byte[] imageData) Sets the binary data representing stereotype's icon.
static void	setPropertiesUIReadOnly(org.eclipse.uml2.uml.Stereotype stereotype, boolean propertiesUIReadOnly) Sets the properties UI Read Only flag for the specified stereotype.
static void	setShapeImage(org.eclipse.uml2.uml.Stereotype stereotype, byte[] shapeImageData) Sets the binary data representing stereotype's shape image.
static void	setSuppressed(org.eclipse.uml2.uml.Property property, boolean value) Sets whether a stereotype property is suppressed.
static void	setSuppressed(org.eclipse.uml2.uml.Stereotype stereotype, boolean value) Sets whether the specified stereotype is suppressed.
static void	setUIReadOnly(org.eclipse.uml2.uml.Property property, boolean uiReadOnly) Sets the UI Read Only flag for the specified property.
static void	setUIReadOnly(org.eclipse.uml2.uml.Stereotype stereotype, boolean uiReadOnly) Sets the UI Read Only flag for the specified stereotype.

Methods inherited from class java.lang.Object

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

Method Detail

getShapeImage

public static byte[] getShapeImage(org.eclipse.uml2.uml.Stereotype stereotype)

Retrieves the binary data representing stereotype's shape image.

Parameters:

stereotype - The stereotype

Returns:

The raw shape image data, or null if there is no shape image on this stereotype

setShapeImage

public static void setShapeImage(org.eclipse.uml2.uml.Stereotype stereotype,
                                 byte[] shapeImageData)

Sets the binary data representing stereotype's shape image.

Parameters:

stereotype - The stereotype

shapeImageData - The raw shape image data. Use null to clear any existing image data

getIcon

public static byte[] getIcon(org.eclipse.uml2.uml.Stereotype stereotype)

Retrieves the binary data representing a stereotype's icon.

Parameters:

stereotype - The stereotype

Returns:

The raw icon data, or null if there is no icon on this stereotype

setIcon

public static void setIcon(org.eclipse.uml2.uml.Stereotype stereotype,
                           byte[] imageData)

Sets the binary data representing stereotype's icon.

Parameters:

stereotype - The stereotype

imageData - The raw icon data. Use null to clear any existing icon data

isSuppressed

public static boolean isSuppressed(org.eclipse.uml2.uml.Stereotype stereotype)

Queries whether the specified stereotype is suppressed.

Parameters:

stereotype - The stereotype

Returns:

Indicator if the stereotype is suppressed

setSuppressed

public static void setSuppressed(org.eclipse.uml2.uml.Stereotype stereotype,
                                 boolean value)

Sets whether the specified stereotype is suppressed.

Parameters:

stereotype - The stereotype

value - Indicator if the stereotype is suppressed

isSuppressed

public static boolean isSuppressed(org.eclipse.uml2.uml.Property property)

Queries whether the specified stereotype property is suppressed.

Parameters:

property - The stereotype property

Returns:

Indicator if the stereotype property is suppressed

setSuppressed

public static void setSuppressed(org.eclipse.uml2.uml.Property property,
                                 boolean value)

Sets whether a stereotype property is suppressed.

Parameters:

property - The stereotype property

value - Indicator if the stereotype property is suppressed

Throws:

java.lang.UnsupportedOperationException - If the property is not owned by a stereotype

isUIReadOnly

public static boolean isUIReadOnly(org.eclipse.uml2.uml.Stereotype stereotype)

Queries whether the specified stereotype is UI Read Only.

Parameters:

stereotype - The stereotype

Returns:

Indicator if it is UI Read Only

setUIReadOnly

public static void setUIReadOnly(org.eclipse.uml2.uml.Stereotype stereotype,
                                 boolean uiReadOnly)

Sets the UI Read Only flag for the specified stereotype.

Parameters:

stereotype - The stereotype

uiReadOnly - Indicator if it is UI Read Only

isUIReadOnly

public static boolean isUIReadOnly(org.eclipse.uml2.uml.Property property)

Queries whether the specified property is UI Read Only.

Parameters:

property - The property

Returns:

Indicator if it is UI Read Only

setUIReadOnly

public static void setUIReadOnly(org.eclipse.uml2.uml.Property property,
                                 boolean uiReadOnly)

Sets the UI Read Only flag for the specified property.

Parameters:

property - The property

uiReadOnly - Indicator if it is UI Read Only

isPropertiesUIReadOnly

public static boolean isPropertiesUIReadOnly(org.eclipse.uml2.uml.Stereotype stereotype)

Queries whether the specified stereotype's properties are UI Read Only.

Parameters:

stereotype - The stereotype

Returns:

Indicator if the properties are UI Read Only

setPropertiesUIReadOnly

public static void setPropertiesUIReadOnly(org.eclipse.uml2.uml.Stereotype stereotype,
                                           boolean propertiesUIReadOnly)

Sets the properties UI Read Only flag for the specified stereotype.

Parameters:

stereotype - The stereotype

propertiesUIReadOnly - Indicator if its properties are UI Read Only

getCategory

public static java.lang.String getCategory(org.eclipse.uml2.uml.Stereotype stereotype)

Queries a stereotype's localized category.

Parameters:

stereotype - The stereotype

Returns:

The localized category for the stereotype if it is defined; otherwise returns null.

setCategory

public static void setCategory(org.eclipse.uml2.uml.Stereotype stereotype,
                               java.lang.String category)

Sets the stereotype's category.

Parameters:

stereotype - The stereotype

category - The category to assign to the stereotype

define

public static void define(org.eclipse.uml2.uml.Profile profile)

Defines the profile using the standard UML2 method, and applies custom extensions, like inserting version information.

Parameters:

profile - The profile to be defined