com.ibm.xtools.uml.msl.lang

Class AbstractLanguageDescriptor

java.lang.Object

com.ibm.xtools.uml.msl.lang.AbstractLanguageDescriptor

All Implemented Interfaces:

IUMLLanguageDescriptor

public abstract class AbstractLanguageDescriptor
extends java.lang.Object
implements IUMLLanguageDescriptor

This is the base implementation for an IUMLLanguageDescriptor.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractLanguageDescriptor(java.lang.String langId, java.lang.String name) Constructor for a given language.
protected	AbstractLanguageDescriptor(java.lang.String langId, java.lang.String name, java.lang.String extension) Constructor when the language extension is known.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayName() The display name is unchangeable.
java.util.Collection<java.lang.String>	getLanguageActivityIDs()
java.lang.String	getLanguageExtension()
java.lang.String	getLanguageID()
java.util.Collection<org.eclipse.emf.common.util.URI>	getLanguageLibraryURIs()
protected org.eclipse.uml2.uml.Package	getLibrary(org.eclipse.emf.ecore.resource.ResourceSet resourceSet, java.lang.String name) Gets the library with the specified name.
protected java.util.Collection<java.lang.String>	getPrimitiveTypeLibraryNames() The names of the primitive type libraries (Packages) that contain the specialized primitive types.
java.util.Collection<org.eclipse.uml2.uml.PrimitiveType>	getPrimitiveTypes(org.eclipse.emf.ecore.resource.ResourceSet set) Gets the primitive types associated with this language.
java.util.Collection<org.eclipse.emf.common.util.URI>	getProfileURIs()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractLanguageDescriptor

protected AbstractLanguageDescriptor(java.lang.String langId,
                                     java.lang.String name)

Constructor for a given language. Note if an extension is not supplied "txt" will be used

Parameters:

langId - The unique language id to be used when storing a language in the model (Must not be null)

name - A user readable display name if extra description is necessary (Must not be null)

AbstractLanguageDescriptor

protected AbstractLanguageDescriptor(java.lang.String langId,
                                     java.lang.String name,
                                     java.lang.String extension)

Constructor when the language extension is known.

Parameters:

langId - The unique language id to be used when storing a language in the model (Must not be null)

name - A user readable display name if extra description is necessary (Must not be null)

extension - The file extension typically associated with this language

Method Detail

getLanguageID

public java.lang.String getLanguageID()

Specified by:

getLanguageID in interface IUMLLanguageDescriptor

Returns:

the language identifier for this particular language to be used within the model

getLanguageExtension

public java.lang.String getLanguageExtension()

Specified by:

getLanguageExtension in interface IUMLLanguageDescriptor

Returns:

a language extension (e.g. txt) that would be commonly associated with the language

getDisplayName

public final java.lang.String getDisplayName()

The display name is unchangeable.

Specified by:

getDisplayName in interface IUMLLanguageDescriptor

Returns:

The user readable display name

getLanguageActivityIDs

public java.util.Collection<java.lang.String> getLanguageActivityIDs()

Specified by:

getLanguageActivityIDs in interface IUMLLanguageDescriptor

Returns:

the Collection of activity ID's that enable language specified actions / UI in the workbench.

getLanguageLibraryURIs

public java.util.Collection<org.eclipse.emf.common.util.URI> getLanguageLibraryURIs()

Specified by:

getLanguageLibraryURIs in interface IUMLLanguageDescriptor

Returns:

the Collection of URI's that point to library models that are required for this particular language.

getProfileURIs

public java.util.Collection<org.eclipse.emf.common.util.URI> getProfileURIs()

Specified by:

getProfileURIs in interface IUMLLanguageDescriptor

Returns:

the Collection of URI's that point to profiles that are required for this particular language.

getPrimitiveTypes

public java.util.Collection<org.eclipse.uml2.uml.PrimitiveType> getPrimitiveTypes(org.eclipse.emf.ecore.resource.ResourceSet set)

Gets the primitive types associated with this language.

Specified by:

getPrimitiveTypes in interface IUMLLanguageDescriptor

Parameters:

set - the resource set to use as context

getPrimitiveTypeLibraryNames

protected java.util.Collection<java.lang.String> getPrimitiveTypeLibraryNames()

The names of the primitive type libraries (Packages) that contain the specialized primitive types.

Returns:

the names of packages containing specialized primitive types or an empty set.

See Also:

getPrimitiveTypes(ResourceSet)

getLibrary

protected org.eclipse.uml2.uml.Package getLibrary(org.eclipse.emf.ecore.resource.ResourceSet resourceSet,
                                                  java.lang.String name)

Gets the library with the specified name.

Returns:

the Package that is the root of the model library. or null if not found.