org.eclipse.uml2
Interface Profile

All Superinterfaces:

Element, EModelElement, EObject, NamedElement, Namespace, Notifier, Package, PackageableElement, ParameterableElement, TemplateableElement

public interface Profile

extends Package

A representation of the model object 'Profile'.

The following features are supported:

• Owned Stereotype
• Metaclass Reference
• Metamodel Reference

See Also:

UML2Package.getProfile()

Field Summary

static java.lang.String

copyright

Fields inherited from interface org.eclipse.uml2.NamedElement

SEPARATOR

Method Summary

EObject	create(Classifier classifier) Creates and returns an instance of (the Ecore representation of) the specified classifier defined in this profile.
Stereotype	createOwnedStereotype(java.lang.String name, boolean isAbstract) Creates a(n) (abstract) stereotype with the specified name as an owned stereotype of this profile.
void	define() Defines this profile by (re)creating Ecore representations of its current contents and incrementing its version.
EList	getMetaclassReferences() Returns the value of the 'Metaclass Reference' reference list.
EList	getMetamodelReferences() Returns the value of the 'Metamodel Reference' reference list.
Stereotype	getOwnedStereotype(java.lang.String name) Retrieves the Stereotype with the specified 'Name' from the 'Owned Stereotype' reference list
EList	getOwnedStereotypes() Returns the value of the 'Owned Stereotype' reference list.
java.util.Set	getReferencedMetaclasses() Retrieves the set of metaclasses referenced by this profile.
java.util.Set	getReferencedMetamodels() Retrieves the set of metamodels referenced by this profile.
java.lang.String	getVersion() Retrieves the version of this profile.
boolean	isDefined() Determines whether this profile is defined.
void	referenceMetaclass(Class class_) References the specified metaclass in this profile with private visibility.
void	referenceMetamodel(Model model) References the specified metamodel in this profile with private visibility.

Methods inherited from interface org.eclipse.uml2.Package

apply, createNestedPackage, createOwnedClass, createOwnedEnumeraton, createOwnedMember, createOwnedPrimitiveType, createPackageExtension, createPackageExtension, createPackageMerge, createPackageMerge, getAllAppliedProfiles, getAppliedProfiles, getAppliedVersion, getNestedPackage, getNestedPackages, getNestingPackage, getOwnedMember, getOwnedMembers, getOwnedType, getOwnedTypes, getPackageExtensions, getPackageMerges, isApplied, makesVisible, unapply, validateElementsPublicOrPrivate, visibleMembers

Methods inherited from interface org.eclipse.uml2.Namespace

createElementImport, createElementImport, createOwnedRule, createOwnedRule, createPackageImport, createPackageImport, excludeCollisions, getElementImports, getImportedMember, getImportedMembers, getImportedPackages, getMember, getMembers, getNamesOfMember, getOwnedRule, getOwnedRules, getPackageImports, importedMember, importElement, importMembers, importPackage, membersAreDistinguishable, validateImportedMemberDerived, validateMembersAreDistinguishable

Methods inherited from interface org.eclipse.uml2.NamedElement

allNamespaces, createDependency, createNameExpression, createNameExpression, getClientDependencies, getClientDependency, getLabel, getLabel, getName, getNameExpression, getNamespace, getQualifiedName, getVisibility, isDistinguishableFrom, qualifiedName, separator, setName, setNameExpression, setVisibility, validateNoName, validateQualifiedName, validateVisibilityNeedsOwnership

Methods inherited from interface org.eclipse.uml2.TemplateableElement

createOwnedTemplateSignature, createOwnedTemplateSignature, createTemplateBinding, createTemplateBinding, getOwnedTemplateSignature, getTemplateBindings, parameterableElements, setOwnedTemplateSignature

Methods inherited from interface org.eclipse.uml2.Element

addKeyword, allOwnedElements, apply, createEAnnotation, createOwnedComment, createOwnedComment, destroy, getApplicableStereotype, getApplicableStereotypes, getAppliedStereotype, getAppliedStereotypes, getAppliedVersion, getKeywords, getModel, getNearestPackage, getOwnedComments, getOwnedElements, getOwner, getValue, hasKeyword, hasValue, isApplied, isRequired, mustBeOwned, removeKeyword, setValue, unapply, validateHasOwner, validateNotOwnSelf

Methods inherited from interface org.eclipse.emf.ecore.EModelElement

getEAnnotation, getEAnnotations

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Methods inherited from interface org.eclipse.uml2.PackageableElement

getPackageableElement_visibility, setPackageableElement_visibility

Methods inherited from interface org.eclipse.uml2.ParameterableElement

getOwningParameter, getTemplateParameter, setOwningParameter, setTemplateParameter

Field Detail

copyright

public static final java.lang.String copyright

See Also:

Constant Field Values

Method Detail

getOwnedStereotypes

public EList getOwnedStereotypes()

Returns the value of the 'Owned Stereotype' reference list. The list contents are of type Stereotype.

If the meaning of the 'Owned Stereotype' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Owned Stereotype' reference list.

See Also:

UML2Package.getProfile_OwnedStereotype()

getOwnedStereotype

public Stereotype getOwnedStereotype(java.lang.String name)

Retrieves the Stereotype with the specified 'Name' from the 'Owned Stereotype' reference list.

Parameters:

name - The 'Name' of the Stereotype to retrieve.

Returns:

The Stereotype with the specified 'Name', or null.

See Also:

getOwnedStereotypes()

getMetaclassReferences

public EList getMetaclassReferences()

Returns the value of the 'Metaclass Reference' reference list. The list contents are of type ElementImport.

If the meaning of the 'Metaclass Reference' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Metaclass Reference' reference list.

See Also:

UML2Package.getProfile_MetaclassReference()

getMetamodelReferences

public EList getMetamodelReferences()

Returns the value of the 'Metamodel Reference' reference list. The list contents are of type PackageImport.

If the meaning of the 'Metamodel Reference' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Metamodel Reference' reference list.

See Also:

UML2Package.getProfile_MetamodelReference()

isDefined

public boolean isDefined()

Determines whether this profile is defined.

Returns:

true if this profile is defined; false otherwise.

getVersion

public java.lang.String getVersion()

Retrieves the version of this profile.

Returns:

The version of this profile, or null if undefined.

define

public void define()

Defines this profile by (re)creating Ecore representations of its current contents and incrementing its version.

Throws:

java.lang.IllegalArgumentException - If this profile has no name.

getReferencedMetaclasses

public java.util.Set getReferencedMetaclasses()

Retrieves the set of metaclasses referenced by this profile.

Returns:

The metaclasses referenced by this profile.

referenceMetaclass

public void referenceMetaclass(Class class_)

References the specified metaclass in this profile with private visibility.

Parameters:

class_ - The metaclass to reference.

Throws:

java.lang.IllegalArgumentException - If this profile already references the metaclass.

getReferencedMetamodels

public java.util.Set getReferencedMetamodels()

Retrieves the set of metamodels referenced by this profile.

Returns:

The metamodels referenced by this profile.

referenceMetamodel

public void referenceMetamodel(Model model)

References the specified metamodel in this profile with private visibility.

Parameters:

model - The metamodel to reference.

Throws:

java.lang.IllegalArgumentException - If this profile already references the metamodel.

create

public EObject create(Classifier classifier)

Creates and returns an instance of (the Ecore representation of) the specified classifier defined in this profile.

Parameters:

classifier - The classifier whose Ecore representation is to be instantiated.

Returns:

An (Ecore) instance of the classifier.

Throws:

java.lang.IllegalArgumentException - If the classifier is not defined in this profile or cannot be instantiated.

createOwnedStereotype

public Stereotype createOwnedStereotype(java.lang.String name,
                                        boolean isAbstract)

Creates a(n) (abstract) stereotype with the specified name as an owned stereotype of this profile.

Parameters:

name - The name for the owned stereotype.

isAbstract - Whether the owned stereotype should be abstract.

Returns:

The new stereotype.

Throws:

java.lang.IllegalArgumentException - If the name is empty.