org.eclipse.emf.codegen.ecore.genmodel
Interface GenPackage
- All Superinterfaces:
- EObject, GenBase, Notifier
- All Known Implementing Classes:
- GenPackageImpl
- public interface GenPackage
- extends GenBase
A representation of the model object 'Gen Package'.
The following features are supported:
- See Also:
GenModelPackage.getGenPackage()
Method Summary |
void |
generateSchema()
Deprecated. Use GenBase.generateSchema(IProgressMonitor) instead. This
method will be removed soon. |
String |
getActionBarContributorClassName()
|
List |
getAdapterDelegatePackages()
|
List |
getAdapterDelegateSuperClasses()
|
String |
getAdapterFactoryClassName()
|
String |
getAdapterFactoryDelegateName(GenPackage genDelegate)
|
List |
getAllAnnotations()
|
List |
getAllGenDataTypes()
|
List |
getAllGenFeatures()
|
List |
getAllSwitchGenClasses()
|
List |
getAllValidatorBaseGenPackages()
|
String |
getAnnotatedModelElementAccessor(EAnnotation eAnnotation)
|
String |
getAnnotationSourceIdentifier(String annotationSource)
|
List |
getAnnotationSources()
|
String |
getBasePackage()
Returns the value of the 'Base Package' attribute |
String |
getClassifierID(GenClassifier genClassifier)
|
int |
getClassifierValue(GenClassifier genClassifier)
|
String |
getClassPackageName()
|
String |
getClassUniqueName(GenClass genClass)
|
EPackage |
getEcorePackage()
Returns the value of the 'Ecore Package' reference |
String |
getEditorClassName()
|
String |
getEditorPluginClassName()
|
String |
getEditPluginClassName()
|
String |
getFactoryClassName()
|
String |
getFactoryInterfaceName()
|
EList |
getGenClasses()
Returns the value of the 'Gen Classes' containment reference list.
|
EList |
getGenClassifiers()
Returns the value of the 'Gen Classifiers' reference list.
|
EList |
getGenDataTypes()
Returns the value of the 'Gen Data Types' containment reference list.
|
EList |
getGenEnums()
Returns the value of the 'Gen Enums' containment reference list.
|
GenModel |
getGenModel()
Returns the value of the 'Gen Model' container reference.
|
String |
getImportedActionBarContributorClassName()
|
String |
getImportedAdapterFactoryClassName()
|
String |
getImportedEditorClassName()
|
String |
getImportedEditorPluginClassName()
|
String |
getImportedEditPluginClassName()
|
String |
getImportedFactoryClassName()
|
String |
getImportedFactoryInterfaceName()
|
String |
getImportedItemProviderAdapterFactoryClassName()
|
String |
getImportedModelWizardClassName()
|
String |
getImportedPackageClassName()
|
String |
getImportedPackageInterfaceName()
|
String |
getImportedResourceBaseClassName()
|
String |
getImportedResourceClassName()
|
String |
getImportedResourceFactoryBaseClassName()
|
String |
getImportedResourceFactoryClassName()
|
String |
getImportedValidatorClassName()
|
String |
getInterfacePackageName()
|
String |
getItemProviderAdapterFactoryClassName()
|
List |
getJavaLangConflicts()
|
int |
getLocalClassifierIndex(GenClassifier genClassifier)
|
String |
getModelWizardClassName()
|
EList |
getNestedGenPackages()
Returns the value of the 'Nested Gen Packages' containment reference list.
|
String |
getNSName()
|
String |
getNSURI()
|
List |
getOrderedGenClasses()
Returns the list of GenClasses in the GenPackage, ordered such that
a class always follows all of the classes it extends. |
List |
getOrderedGenClassifiers()
|
List |
getPackageBuildInterDependencies()
|
String |
getPackageClassName()
|
List |
getPackageInitializationDependencies()
|
String |
getPackageInstanceVariable(GenPackage genPackage)
|
List |
getPackageInterDependencies()
|
String |
getPackageInterfaceName()
|
List |
getPackageLoadInterDependencies()
|
String |
getPackageName()
|
List |
getPackageSimpleDependencies()
|
String |
getPrefix()
Returns the value of the 'Prefix' attribute |
String |
getPresentationPackageName()
|
String |
getProviderPackageName()
|
String |
getQualifiedActionBarContributorClassName()
|
String |
getQualifiedAdapterFactoryClassName()
|
String |
getQualifiedEditorClassName()
|
String |
getQualifiedEditorPluginClassName()
|
String |
getQualifiedEditPluginClassName()
|
String |
getQualifiedFactoryClassName()
|
String |
getQualifiedFactoryInterfaceName()
|
String |
getQualifiedItemProviderAdapterFactoryClassName()
|
String |
getQualifiedModelWizardClassName()
|
String |
getQualifiedPackageClassName()
|
String |
getQualifiedPackageInterfaceName()
|
String |
getQualifiedResourceClassName()
|
String |
getQualifiedResourceFactoryClassName()
|
GenResourceKind |
getResource()
Returns the value of the 'Resource' attribute.
|
String |
getResourceClassName()
|
String |
getResourceFactoryClassName()
|
GenPackage |
getRootGenPackage()
Returns the top-most GenPackage-typed container for which
hasClassifiers() is true, which may be this GenPackage, itself. |
String |
getSerializedPackageFilename()
|
List |
getSubGenPackages()
Returns a list of those nestedGenPackages for which hasClassifiers() is
true. |
GenPackage |
getSuperGenPackage()
Returns the closest GenPackage-typed container for which
hasClassifiers() is true, or null if there is none. |
String |
getSwitchClassName()
|
String |
getUncapAdapterFactoryClassName()
|
String |
getUncapAdapterFactoryDelegateName(GenPackage genDelegate)
|
String |
getUncapFactoryInterfaceName()
|
String |
getUncapPackageInterfaceName()
|
String |
getUtilitiesPackageName()
|
String |
getValidatorClassName()
|
String |
getValidatorPackageUniqueSafeName(GenPackage genPackage)
|
boolean |
hasClassifiers()
|
boolean |
hasConstraints()
|
boolean |
hasDocumentRoot()
|
boolean |
hasExtendedMetaData()
|
boolean |
hasInterfaceImplConflict()
|
boolean |
hasJavaLangConflict()
|
boolean |
hasTargetNamespace()
|
boolean |
hasXMLMap()
|
void |
initialize(EPackage ePackage)
|
boolean |
isAdapterFactory()
Returns the value of the 'Adapter Factory' attribute.
|
boolean |
isEcorePackage()
|
boolean |
isLoadedInitialization()
Returns true if this package's root, which may be itself, requires, or has a subpackage that requires, load initialization. |
boolean |
isLoadingInitialization()
Returns true if this is a root package that requires, or has a direct or indirect subpackage that requires, load initialization. |
boolean |
isLoadInitialization()
Returns the value of the 'Load Initialization' attribute |
boolean |
reconcile(GenPackage oldGenPackageVersion)
|
void |
setAdapterFactory(boolean value)
Sets the value of the 'Adapter Factory ' attribute |
void |
setBasePackage(String value)
Sets the value of the 'Base Package ' attribute |
void |
setEcorePackage(EPackage value)
Sets the value of the 'Ecore Package ' reference |
void |
setGenModel(GenModel value)
Sets the value of the 'Gen Model ' container reference |
void |
setLoadInitialization(boolean value)
Sets the value of the 'Load Initialization ' attribute |
void |
setPrefix(String value)
Sets the value of the 'Prefix ' attribute |
void |
setResource(GenResourceKind value)
Sets the value of the 'Resource ' attribute |
Methods inherited from interface org.eclipse.emf.codegen.ecore.genmodel.GenBase |
canGenerate, canGenerateEdit, canGenerateEditor, canGenerateSchema, capName, ePackageGenModel, format, generate, generateEdit, generateEditor, generateSchema, getDocumentation, hasDocumentation, reconcile, safeName, uncapName, uncapPrefixedName |
Methods inherited from interface org.eclipse.emf.ecore.EObject |
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset |
getPrefix
public String getPrefix()
- Returns the value of the 'Prefix' attribute.
If the meaning of the 'Prefix' attribute isn't clear,
there really should be more of a description here...
- Returns:
- the value of the 'Prefix' attribute.
- See Also:
setPrefix(String)
,
GenModelPackage.getGenPackage_Prefix()
setPrefix
public void setPrefix(String value)
- Sets the value of the '
Prefix
' attribute.
- Parameters:
value
- the new value of the 'Prefix' attribute.- See Also:
getPrefix()
getBasePackage
public String getBasePackage()
- Returns the value of the 'Base Package' attribute.
If the meaning of the 'Base Package' attribute isn't clear,
there really should be more of a description here...
- Returns:
- the value of the 'Base Package' attribute.
- See Also:
setBasePackage(String)
,
GenModelPackage.getGenPackage_BasePackage()
setBasePackage
public void setBasePackage(String value)
- Sets the value of the '
Base Package
' attribute.
- Parameters:
value
- the new value of the 'Base Package' attribute.- See Also:
getBasePackage()
getResource
public GenResourceKind getResource()
- Returns the value of the 'Resource' attribute.
The literals are from the enumeration
GenResourceKind
.
If the meaning of the 'Resource' attribute isn't clear,
there really should be more of a description here...
- Returns:
- the value of the 'Resource' attribute.
- See Also:
GenResourceKind
,
setResource(GenResourceKind)
,
GenModelPackage.getGenPackage_Resource()
setResource
public void setResource(GenResourceKind value)
- Sets the value of the '
Resource
' attribute.
- Parameters:
value
- the new value of the 'Resource' attribute.- See Also:
GenResourceKind
,
getResource()
isAdapterFactory
public boolean isAdapterFactory()
- Returns the value of the 'Adapter Factory' attribute.
The default value is
"true"
.
If the meaning of the 'Adapter Factory' attribute isn't clear,
there really should be more of a description here...
- Returns:
- the value of the 'Adapter Factory' attribute.
- See Also:
setAdapterFactory(boolean)
,
GenModelPackage.getGenPackage_AdapterFactory()
setAdapterFactory
public void setAdapterFactory(boolean value)
- Sets the value of the '
Adapter Factory
' attribute.
- Parameters:
value
- the new value of the 'Adapter Factory' attribute.- See Also:
isAdapterFactory()
isLoadInitialization
public boolean isLoadInitialization()
- Returns the value of the 'Load Initialization' attribute.
If true, the package meta-data will be initialized by loading it from a resource, instead of building it up programmatically.
This should be used for large packasges, for which the generated code for building it would excede the 64k method limit.
- Returns:
- the value of the 'Load Initialization' attribute.
- See Also:
setLoadInitialization(boolean)
,
GenModelPackage.getGenPackage_LoadInitialization()
setLoadInitialization
public void setLoadInitialization(boolean value)
- Sets the value of the '
Load Initialization
' attribute.
- Parameters:
value
- the new value of the 'Load Initialization' attribute.- See Also:
isLoadInitialization()
getEcorePackage
public EPackage getEcorePackage()
- Returns the value of the 'Ecore Package' reference.
If the meaning of the 'Ecore Package' reference isn't clear,
there really should be more of a description here...
- Returns:
- the value of the 'Ecore Package' reference.
- See Also:
setEcorePackage(EPackage)
,
GenModelPackage.getGenPackage_EcorePackage()
setEcorePackage
public void setEcorePackage(EPackage value)
- Sets the value of the '
Ecore Package
' reference.
- Parameters:
value
- the new value of the 'Ecore Package' reference.- See Also:
getEcorePackage()
getGenModel
public GenModel getGenModel()
- Returns the value of the 'Gen Model' container reference.
It is bidirectional and its opposite is '
Gen Packages
'.
If the meaning of the 'Gen Model' reference isn't clear,
there really should be more of a description here...
- Specified by:
getGenModel
in interface GenBase
- Returns:
- the value of the 'Gen Model' container reference.
- See Also:
setGenModel(GenModel)
,
GenModelPackage.getGenPackage_GenModel()
,
GenModel.getGenPackages()
setGenModel
public void setGenModel(GenModel value)
- Sets the value of the '
Gen Model
' container reference.
- Parameters:
value
- the new value of the 'Gen Model' container reference.- See Also:
getGenModel()
getGenEnums
public EList getGenEnums()
- Returns the value of the 'Gen Enums' containment reference list.
The list contents are of type
GenEnum
.
If the meaning of the 'Gen Enums' reference list isn't clear,
there really should be more of a description here...
- Returns:
- the value of the 'Gen Enums' containment reference list.
- See Also:
GenModelPackage.getGenPackage_GenEnums()
getGenDataTypes
public EList getGenDataTypes()
- Returns the value of the 'Gen Data Types' containment reference list.
The list contents are of type
GenDataType
.
If the meaning of the 'Gen Data Types' reference list isn't clear,
there really should be more of a description here...
- Returns:
- the value of the 'Gen Data Types' containment reference list.
- See Also:
GenModelPackage.getGenPackage_GenDataTypes()
getGenClasses
public EList getGenClasses()
- Returns the value of the 'Gen Classes' containment reference list.
The list contents are of type
GenClass
.
If the meaning of the 'Gen Classes' reference list isn't clear,
there really should be more of a description here...
- Returns:
- the value of the 'Gen Classes' containment reference list.
- See Also:
GenModelPackage.getGenPackage_GenClasses()
getNestedGenPackages
public EList getNestedGenPackages()
- Returns the value of the 'Nested Gen Packages' containment reference list.
The list contents are of type
GenPackage
.
If the meaning of the 'Nested Gen Packages' reference list isn't clear,
there really should be more of a description here...
- Returns:
- the value of the 'Nested Gen Packages' containment reference list.
- See Also:
GenModelPackage.getGenPackage_NestedGenPackages()
getGenClassifiers
public EList getGenClassifiers()
- Returns the value of the 'Gen Classifiers' reference list.
The list contents are of type
GenClassifier
.
It is bidirectional and its opposite is 'Gen Package
'.
If the meaning of the 'Gen Meta Objects' reference list isn't clear,
there really should be more of a description here...
- Returns:
- the value of the 'Gen Classifiers' reference list.
- See Also:
GenModelPackage.getGenPackage_GenClassifiers()
,
GenClassifier.getGenPackage()
getInterfacePackageName
public String getInterfacePackageName()
getClassPackageName
public String getClassPackageName()
getUtilitiesPackageName
public String getUtilitiesPackageName()
getNSName
public String getNSName()
getNSURI
public String getNSURI()
getPackageName
public String getPackageName()
getPackageInterfaceName
public String getPackageInterfaceName()
getQualifiedPackageInterfaceName
public String getQualifiedPackageInterfaceName()
getImportedPackageInterfaceName
public String getImportedPackageInterfaceName()
getUncapPackageInterfaceName
public String getUncapPackageInterfaceName()
getPackageClassName
public String getPackageClassName()
getQualifiedPackageClassName
public String getQualifiedPackageClassName()
getImportedPackageClassName
public String getImportedPackageClassName()
getFactoryInterfaceName
public String getFactoryInterfaceName()
getQualifiedFactoryInterfaceName
public String getQualifiedFactoryInterfaceName()
getImportedFactoryInterfaceName
public String getImportedFactoryInterfaceName()
getUncapFactoryInterfaceName
public String getUncapFactoryInterfaceName()
getFactoryClassName
public String getFactoryClassName()
getQualifiedFactoryClassName
public String getQualifiedFactoryClassName()
getImportedFactoryClassName
public String getImportedFactoryClassName()
getAdapterFactoryClassName
public String getAdapterFactoryClassName()
getQualifiedAdapterFactoryClassName
public String getQualifiedAdapterFactoryClassName()
getImportedAdapterFactoryClassName
public String getImportedAdapterFactoryClassName()
getUncapAdapterFactoryClassName
public String getUncapAdapterFactoryClassName()
getSwitchClassName
public String getSwitchClassName()
getValidatorClassName
public String getValidatorClassName()
getImportedValidatorClassName
public String getImportedValidatorClassName()
getAllGenDataTypes
public List getAllGenDataTypes()
getOrderedGenClasses
public List getOrderedGenClasses()
- Returns the list of GenClasses in the GenPackage, ordered such that
a class always follows all of the classes it extends. Appropriate
for use in package interface to declare feature constants, which will
depend on (and hence must follow) constants for the extended class.
getOrderedGenClassifiers
public List getOrderedGenClassifiers()
getClassifierID
public String getClassifierID(GenClassifier genClassifier)
getClassifierValue
public int getClassifierValue(GenClassifier genClassifier)
getLocalClassifierIndex
public int getLocalClassifierIndex(GenClassifier genClassifier)
getPackageSimpleDependencies
public List getPackageSimpleDependencies()
getPackageInterDependencies
public List getPackageInterDependencies()
getPackageLoadInterDependencies
public List getPackageLoadInterDependencies()
getPackageBuildInterDependencies
public List getPackageBuildInterDependencies()
getPackageInitializationDependencies
public List getPackageInitializationDependencies()
getPackageInstanceVariable
public String getPackageInstanceVariable(GenPackage genPackage)
getSubGenPackages
public List getSubGenPackages()
- Returns a list of those nestedGenPackages for which hasClassifiers() is
true.
getSuperGenPackage
public GenPackage getSuperGenPackage()
- Returns the closest GenPackage-typed container for which
hasClassifiers() is true, or null if there is none.
getRootGenPackage
public GenPackage getRootGenPackage()
- Returns the top-most GenPackage-typed container for which
hasClassifiers() is true, which may be this GenPackage, itself.
isLoadingInitialization
public boolean isLoadingInitialization()
- Returns true if this is a root package that requires, or has a direct or indirect subpackage that requires, load initialization.
isLoadedInitialization
public boolean isLoadedInitialization()
- Returns true if this package's root, which may be itself, requires, or has a subpackage that requires, load initialization.
isEcorePackage
public boolean isEcorePackage()
hasInterfaceImplConflict
public boolean hasInterfaceImplConflict()
hasJavaLangConflict
public boolean hasJavaLangConflict()
getJavaLangConflicts
public List getJavaLangConflicts()
hasClassifiers
public boolean hasClassifiers()
getAllSwitchGenClasses
public List getAllSwitchGenClasses()
getClassUniqueName
public String getClassUniqueName(GenClass genClass)
getAllValidatorBaseGenPackages
public List getAllValidatorBaseGenPackages()
getValidatorPackageUniqueSafeName
public String getValidatorPackageUniqueSafeName(GenPackage genPackage)
initialize
public void initialize(EPackage ePackage)
generateSchema
public void generateSchema()
- Deprecated. Use
GenBase.generateSchema(IProgressMonitor)
instead. This
method will be removed soon.
getProviderPackageName
public String getProviderPackageName()
getPresentationPackageName
public String getPresentationPackageName()
getItemProviderAdapterFactoryClassName
public String getItemProviderAdapterFactoryClassName()
getQualifiedItemProviderAdapterFactoryClassName
public String getQualifiedItemProviderAdapterFactoryClassName()
getImportedItemProviderAdapterFactoryClassName
public String getImportedItemProviderAdapterFactoryClassName()
getEditorClassName
public String getEditorClassName()
getQualifiedEditorClassName
public String getQualifiedEditorClassName()
getImportedEditorClassName
public String getImportedEditorClassName()
getModelWizardClassName
public String getModelWizardClassName()
getQualifiedModelWizardClassName
public String getQualifiedModelWizardClassName()
getImportedModelWizardClassName
public String getImportedModelWizardClassName()
getActionBarContributorClassName
public String getActionBarContributorClassName()
getQualifiedActionBarContributorClassName
public String getQualifiedActionBarContributorClassName()
getImportedActionBarContributorClassName
public String getImportedActionBarContributorClassName()
getAdapterFactoryDelegateName
public String getAdapterFactoryDelegateName(GenPackage genDelegate)
getUncapAdapterFactoryDelegateName
public String getUncapAdapterFactoryDelegateName(GenPackage genDelegate)
getEditPluginClassName
public String getEditPluginClassName()
getQualifiedEditPluginClassName
public String getQualifiedEditPluginClassName()
getImportedEditPluginClassName
public String getImportedEditPluginClassName()
getEditorPluginClassName
public String getEditorPluginClassName()
getQualifiedEditorPluginClassName
public String getQualifiedEditorPluginClassName()
getImportedEditorPluginClassName
public String getImportedEditorPluginClassName()
getAllGenFeatures
public List getAllGenFeatures()
getAdapterDelegatePackages
public List getAdapterDelegatePackages()
getAdapterDelegateSuperClasses
public List getAdapterDelegateSuperClasses()
reconcile
public boolean reconcile(GenPackage oldGenPackageVersion)
getAnnotationSources
public List getAnnotationSources()
getAnnotationSourceIdentifier
public String getAnnotationSourceIdentifier(String annotationSource)
getAllAnnotations
public List getAllAnnotations()
getAnnotatedModelElementAccessor
public String getAnnotatedModelElementAccessor(EAnnotation eAnnotation)
getResourceClassName
public String getResourceClassName()
getQualifiedResourceClassName
public String getQualifiedResourceClassName()
getImportedResourceClassName
public String getImportedResourceClassName()
getImportedResourceBaseClassName
public String getImportedResourceBaseClassName()
getResourceFactoryClassName
public String getResourceFactoryClassName()
getQualifiedResourceFactoryClassName
public String getQualifiedResourceFactoryClassName()
getImportedResourceFactoryClassName
public String getImportedResourceFactoryClassName()
getImportedResourceFactoryBaseClassName
public String getImportedResourceFactoryBaseClassName()
hasXMLMap
public boolean hasXMLMap()
hasDocumentRoot
public boolean hasDocumentRoot()
hasExtendedMetaData
public boolean hasExtendedMetaData()
hasTargetNamespace
public boolean hasTargetNamespace()
hasConstraints
public boolean hasConstraints()
getSerializedPackageFilename
public String getSerializedPackageFilename()