diff options
author | gkessler | 2007-05-11 17:55:21 +0000 |
---|---|---|
committer | gkessler | 2007-05-11 17:55:21 +0000 |
commit | 4c8110b13872cdcb8607d38fc5ce8fb84c6f6099 (patch) | |
tree | 2b282e348c48799c98616da66eda196514e059b6 /jsf/plugins/org.eclipse.jst.jsf.common | |
parent | 245e880dfeb288c78722918ac62b44be3a194a65 (diff) | |
download | webtools.jsf-4c8110b13872cdcb8607d38fc5ce8fb84c6f6099.tar.gz webtools.jsf-4c8110b13872cdcb8607d38fc5ce8fb84c6f6099.tar.xz webtools.jsf-4c8110b13872cdcb8607d38fc5ce8fb84c6f6099.zip |
MD JavaDoc fixes
Diffstat (limited to 'jsf/plugins/org.eclipse.jst.jsf.common')
42 files changed, 435 insertions, 98 deletions
diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/Entity.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/Entity.java index f1a0c1444..50dff460d 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/Entity.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/Entity.java @@ -143,6 +143,7 @@ public interface Entity extends EObject { /** * <!-- begin-user-doc --> + * @param visitor * <!-- end-user-doc --> * @model visitorDataType="org.eclipse.jst.jsf.common.metadata.query.IEntityVisitor" * @generated @@ -151,6 +152,7 @@ public interface Entity extends EObject { /** * <!-- begin-user-doc --> + * @return Model * <!-- end-user-doc --> * @model kind="operation" * @generated diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/IncludeEntityGroup.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/IncludeEntityGroup.java index 1ded89043..02318edbd 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/IncludeEntityGroup.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/IncludeEntityGroup.java @@ -31,7 +31,7 @@ public interface IncludeEntityGroup extends EObject { * <!-- end-user-doc --> * @generated */ - String copyright = "Copyright (c) 2007 Oracle Corporation"; + String copyright = "Copyright (c) 2007 Oracle Corporation"; //$NON-NLS-1$ /** * Returns the value of the '<em><b>Id</b></em>' attribute. diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/MetadataFactory.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/MetadataFactory.java index ec1a4e6c3..ed04d7060 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/MetadataFactory.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/MetadataFactory.java @@ -22,7 +22,7 @@ public interface MetadataFactory extends EFactory { * <!-- end-user-doc --> * @generated */ - String copyright = "Copyright (c) 2007 Oracle Corporation"; + String copyright = "Copyright (c) 2007 Oracle Corporation"; //$NON-NLS-1$ /** * The singleton instance of the factory. diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/MetadataPackage.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/MetadataPackage.java index 48fea9654..cb3e5034b 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/MetadataPackage.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/MetadataPackage.java @@ -678,6 +678,7 @@ public interface MetadataPackage extends EPackage { * @see org.eclipse.jst.jsf.common.metadata.internal.impl.MetadataPackageImpl#getTrait() * @generated */ + @SuppressWarnings("hiding") EClass TRAIT = eINSTANCE.getTrait(); /** @@ -686,6 +687,7 @@ public interface MetadataPackage extends EPackage { * <!-- end-user-doc --> * @generated */ + @SuppressWarnings("hiding") EAttribute TRAIT__ID = eINSTANCE.getTrait_Id(); /** @@ -694,6 +696,7 @@ public interface MetadataPackage extends EPackage { * <!-- end-user-doc --> * @generated */ + @SuppressWarnings("hiding") EReference TRAIT__VALUE = eINSTANCE.getTrait_Value(); /** @@ -702,6 +705,7 @@ public interface MetadataPackage extends EPackage { * <!-- end-user-doc --> * @generated */ + @SuppressWarnings("hiding") EAttribute TRAIT__SOURCE_MODEL_PROVIDER = eINSTANCE.getTrait_SourceModelProvider(); /** @@ -712,6 +716,7 @@ public interface MetadataPackage extends EPackage { * @see org.eclipse.jst.jsf.common.metadata.internal.impl.MetadataPackageImpl#getIncludeEntityGroup() * @generated */ + @SuppressWarnings("hiding") EClass INCLUDE_ENTITY_GROUP = eINSTANCE.getIncludeEntityGroup(); /** @@ -720,6 +725,7 @@ public interface MetadataPackage extends EPackage { * <!-- end-user-doc --> * @generated */ + @SuppressWarnings("hiding") EAttribute INCLUDE_ENTITY_GROUP__ID = eINSTANCE.getIncludeEntityGroup_Id(); /** @@ -728,6 +734,7 @@ public interface MetadataPackage extends EPackage { * <!-- end-user-doc --> * @generated */ + @SuppressWarnings("hiding") EAttribute INCLUDE_ENTITY_GROUP__MODEL_URI = eINSTANCE.getIncludeEntityGroup_ModelUri(); /** @@ -738,6 +745,7 @@ public interface MetadataPackage extends EPackage { * @see org.eclipse.jst.jsf.common.metadata.internal.impl.MetadataPackageImpl#getModel() * @generated */ + @SuppressWarnings("hiding") EClass MODEL = eINSTANCE.getModel(); /** @@ -746,6 +754,7 @@ public interface MetadataPackage extends EPackage { * <!-- end-user-doc --> * @generated */ + @SuppressWarnings("hiding") EAttribute MODEL__SOURCE_MODEL_PROVIDER = eINSTANCE.getModel_SourceModelProvider(); /** @@ -754,6 +763,7 @@ public interface MetadataPackage extends EPackage { * <!-- end-user-doc --> * @generated */ + @SuppressWarnings("hiding") EAttribute MODEL__CURRENT_MODEL_CONTEXT = eINSTANCE.getModel_CurrentModelContext(); /** @@ -762,6 +772,7 @@ public interface MetadataPackage extends EPackage { * <!-- end-user-doc --> * @generated */ + @SuppressWarnings("hiding") EReference MODEL__ENTITY_GROUPS = eINSTANCE.getModel_EntityGroups(); /** @@ -772,6 +783,7 @@ public interface MetadataPackage extends EPackage { * @see org.eclipse.jst.jsf.common.metadata.internal.impl.MetadataPackageImpl#getEntity() * @generated */ + @SuppressWarnings("hiding") EClass ENTITY = eINSTANCE.getEntity(); /** @@ -780,6 +792,7 @@ public interface MetadataPackage extends EPackage { * <!-- end-user-doc --> * @generated */ + @SuppressWarnings("hiding") EReference ENTITY__CHILD_ENTITIES = eINSTANCE.getEntity_ChildEntities(); /** @@ -788,6 +801,7 @@ public interface MetadataPackage extends EPackage { * <!-- end-user-doc --> * @generated */ + @SuppressWarnings("hiding") EReference ENTITY__TRAITS = eINSTANCE.getEntity_Traits(); /** @@ -796,6 +810,7 @@ public interface MetadataPackage extends EPackage { * <!-- end-user-doc --> * @generated */ + @SuppressWarnings("hiding") EAttribute ENTITY__ID = eINSTANCE.getEntity_Id(); /** @@ -804,6 +819,7 @@ public interface MetadataPackage extends EPackage { * <!-- end-user-doc --> * @generated */ + @SuppressWarnings("hiding") EAttribute ENTITY__TYPE = eINSTANCE.getEntity_Type(); /** @@ -812,6 +828,7 @@ public interface MetadataPackage extends EPackage { * <!-- end-user-doc --> * @generated */ + @SuppressWarnings("hiding") EReference ENTITY__INCLUDE_GROUPS = eINSTANCE.getEntity_IncludeGroups(); /** @@ -822,6 +839,7 @@ public interface MetadataPackage extends EPackage { * @see org.eclipse.jst.jsf.common.metadata.internal.impl.MetadataPackageImpl#getEntityGroup() * @generated */ + @SuppressWarnings("hiding") EClass ENTITY_GROUP = eINSTANCE.getEntityGroup(); /** @@ -832,6 +850,7 @@ public interface MetadataPackage extends EPackage { * @see org.eclipse.jst.jsf.common.metadata.internal.impl.MetadataPackageImpl#getITraitVisitor() * @generated */ + @SuppressWarnings("hiding") EDataType ITRAIT_VISITOR = eINSTANCE.getITraitVisitor(); /** @@ -842,6 +861,7 @@ public interface MetadataPackage extends EPackage { * @see org.eclipse.jst.jsf.common.metadata.internal.impl.MetadataPackageImpl#getIEntityVisitor() * @generated */ + @SuppressWarnings("hiding") EDataType IENTITY_VISITOR = eINSTANCE.getIEntityVisitor(); /** @@ -852,6 +872,7 @@ public interface MetadataPackage extends EPackage { * @see org.eclipse.jst.jsf.common.metadata.internal.impl.MetadataPackageImpl#getIMetaDataSourceModelProvider() * @generated */ + @SuppressWarnings("hiding") EDataType IMETA_DATA_SOURCE_MODEL_PROVIDER = eINSTANCE.getIMetaDataSourceModelProvider(); /** @@ -862,6 +883,7 @@ public interface MetadataPackage extends EPackage { * @see org.eclipse.jst.jsf.common.metadata.internal.impl.MetadataPackageImpl#getModelContext() * @generated */ + @SuppressWarnings("hiding") EDataType MODEL_CONTEXT = eINSTANCE.getModelContext(); } diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/Model.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/Model.java index 4801be1b9..abf20f7a1 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/Model.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/Model.java @@ -109,6 +109,8 @@ public interface Model extends Entity { /** * <!-- begin-user-doc --> * <!-- end-user-doc --> + * @param groupId + * @return EntityGroup * @model * @generated */ diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/Trait.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/Trait.java index e698bfe35..06e78c54e 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/Trait.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/Trait.java @@ -34,7 +34,7 @@ public interface Trait extends EObject { * <!-- end-user-doc --> * @generated */ - String copyright = "Copyright (c) 2007 Oracle Corporation"; + String copyright = "Copyright (c) 2007 Oracle Corporation"; //$NON-NLS-1$ /** * Returns the value of the '<em><b>Id</b></em>' attribute. @@ -118,6 +118,7 @@ public interface Trait extends EObject { /** * <!-- begin-user-doc --> * <!-- end-user-doc --> + * @param visitor * @model visitorDataType="org.eclipse.jst.jsf.common.metadata.query.ITraitVisitor" * annotation="http://www.eclipse.org/emf/2002/GenModel body='visitor.visit(this);'" * @generated diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/AbstractTagLibDomainContentModelMetaDataTranslator.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/AbstractTagLibDomainContentModelMetaDataTranslator.java index 09213c6e0..c1f2f9e16 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/AbstractTagLibDomainContentModelMetaDataTranslator.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/AbstractTagLibDomainContentModelMetaDataTranslator.java @@ -23,19 +23,41 @@ import org.eclipse.jst.jsf.common.metadata.Trait; import org.eclipse.wst.xml.core.internal.contentmodel.CMDocument; import org.eclipse.wst.xml.core.internal.contentmodel.CMElementDeclaration; +/** + * Abstract class that the taglib domain translators use to + * convert the CM model to a standard meta data model + * + */ public abstract class AbstractTagLibDomainContentModelMetaDataTranslator { + /** + * {@link IMetaDataModelMergeAssistant} to use + */ protected IMetaDataModelMergeAssistant _assistant; + /** + * Set the assistant to use during the translation. Must be called prior to doTransalate(doc); + * @param assistant + */ protected void setAssistant(IMetaDataModelMergeAssistant assistant){ _assistant = assistant; } + /** + * Transforms the CMDocument into entities and traits of a standard metadata model + * using the assistant that must be set before this call. + * @param doc + */ protected void doTranslate(CMDocument doc){ createTags(doc); createTagfileTraits(doc); } + /** + * @param entity + * @param key + * @param value + */ protected void createSimpleStringEntityTraitIfNecessary(final Entity entity, final String key, final String value) { Trait t = findTraitOnEntityById(entity, key); @@ -50,6 +72,11 @@ public abstract class AbstractTagLibDomainContentModelMetaDataTranslator { } } + /** + * @param entity + * @param key + * @param value + */ protected void createSimpleBooleanObjectEntityTraitIfNecessary(final Entity entity, String key, boolean value) { @@ -66,6 +93,11 @@ public abstract class AbstractTagLibDomainContentModelMetaDataTranslator { } + /** + * @param entity + * @param key + * @return Trait + */ protected Trait internalCreateTrait(final Entity entity, final String key) { Trait t = MetadataFactory.eINSTANCE.createTrait(); t.setId(key); @@ -73,6 +105,12 @@ public abstract class AbstractTagLibDomainContentModelMetaDataTranslator { entity.getTraits().add(t); return t; } + + /** + * @param entity + * @param key + * @return Trait + */ protected Trait findTraitOnEntityById(final Entity entity, final String key) { for (Iterator it=entity.getTraits().iterator();it.hasNext();){ Trait t = (Trait)it.next(); @@ -82,6 +120,10 @@ public abstract class AbstractTagLibDomainContentModelMetaDataTranslator { return null; } + /** + * @param nodeName + * @return Entity + */ protected Entity findTagEntity(final String nodeName) { for (Iterator it=getMergedModel().getChildEntities().iterator();it.hasNext();){ Entity entity = (Entity)it.next(); @@ -91,6 +133,10 @@ public abstract class AbstractTagLibDomainContentModelMetaDataTranslator { return null; } + /** + * Create entities for tags + * @param doc + */ protected void createTags(final CMDocument doc) { for (Iterator it=doc.getElements().iterator();it.hasNext();){ CMElementDeclaration tag = (CMElementDeclaration)it.next(); @@ -106,6 +152,11 @@ public abstract class AbstractTagLibDomainContentModelMetaDataTranslator { } + /** + * Sets the standard traits for a tag entity from the element declaration + * @param tag + * @param entity + */ protected void setTagEntityTraits(CMElementDeclaration tag, Entity entity) { createSimpleStringEntityTraitIfNecessary(entity, "display-label", getTagDisplayName(tag)); createSimpleStringEntityTraitIfNecessary(entity, "description", getTagDescription(tag)); @@ -117,18 +168,46 @@ public abstract class AbstractTagLibDomainContentModelMetaDataTranslator { // createRequiredAttrTraits(entity, tag); } + /** + * @param tag + * @return false. subclass should override if CMElementDeclaration has the metadata. + */ protected boolean getTagIsHidden(CMElementDeclaration tag) {return false;} + /** + * @param tag + * @return false. subclass should override if CMElementDeclaration has the metadata. + */ protected boolean getTagIsExpert(CMElementDeclaration tag) {return false;} + /** + * @param tag + * @return null. subclass should override if CMElementDeclaration has the metadata. + */ protected String getTagLargeIcon(CMElementDeclaration tag) {return null;} + /** + * @param tag + * @return null. subclass should override if CMElementDeclaration has the metadata. + */ protected String getTagSmallIcon(CMElementDeclaration tag) {return null;} + /** + * @param tag + * @return null. subclass should override if CMElementDeclaration has the metadata. + */ protected String getTagDescription(CMElementDeclaration tag) {return null;} + /** + * @param tag + * @return tag.getElementName() + */ protected String getTagDisplayName(CMElementDeclaration tag) {return tag.getElementName();} + /** + * Creates standard traits for tag file entity from CMDocument metadata + * @param doc + */ protected void createTagfileTraits(CMDocument doc) { Model model = getMergedModel(); @@ -140,22 +219,40 @@ public abstract class AbstractTagLibDomainContentModelMetaDataTranslator { } + /** + * @return the display label to use for this model. Subclasses should override if model has the meta data. + */ protected String getURIDisplayLabel(){ return getMergedModel().getId(); } + /** + * @return default prefix to use for tags. Returns null. Subclasses should override if model has the meta data. + */ protected String getURIDefaultPrefix(){ return null; } + /** + * @return description to use. Default is the URI. Subclasses should override if model has the meta data. + */ protected String getURIDescription(){ return getMergedModel().getId(); } + /** + * @return false. Subclasses should override if model has the meta data. + */ protected boolean getURIExpert() { return false;} + /** + * @return false. Subclasses should override if model has the meta data. + */ protected boolean getURIHidden() {return false; } + /** + * @return a model of all entities and traits + */ protected Model getMergedModel() { Model model = (Model)_assistant.getMergedModel().getRoot(); if (model == null){ @@ -167,21 +264,25 @@ public abstract class AbstractTagLibDomainContentModelMetaDataTranslator { return model; } -// protected void createTagTraits(IMetaDataModelMergeAssistant assistant, -// ITaglibDescriptor desc) { -// Model tld = (Model)assistant.getMergedModel().getRoot(); -// } - + /** + * @return new model + */ protected Model createTLDModel() { Model entity = getFactory().createModel(); entity.setId(_assistant.getMergedModel().getModelKey().getUri()); return entity; } + /** + * @return MetadataFactory instance + */ protected MetadataFactory getFactory(){ return (MetadataFactory) MetadataPackage.eINSTANCE.getEFactoryInstance(); } + /** + * @return CMDocument being used for the current translate call + */ protected CMDocument getSourceModel() { return (CMDocument)_assistant.getSourceModelProvider().getSourceModel(); } diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/DomainLoadingStrategy.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/DomainLoadingStrategy.java index 65b777f11..ad81c3d4f 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/DomainLoadingStrategy.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/DomainLoadingStrategy.java @@ -28,9 +28,9 @@ public class DomainLoadingStrategy implements IDomainLoadingStrategy, IMetaDataO */ protected String domain; - private MetaDataModel model; - private List /*<IDomainSourceModelType>*/ sourceTypes; - private List /*<IMetaDataSourceModelProvider>*/ sources; + private MetaDataModel _model; + private List /*<IDomainSourceModelType>*/ _sourceTypes; + private List /*<IMetaDataSourceModelProvider>*/ _sources; /** * Constructor @@ -45,11 +45,11 @@ public class DomainLoadingStrategy implements IDomainLoadingStrategy, IMetaDataO * @see org.eclipse.jst.jsf.common.metadata.internal.IDomainLoadingStrategy#load(org.eclipse.jst.jsf.common.metadata.internal.MetaDataModel) */ public void load(MetaDataModel model) { - this.model = model; - sourceTypes = loadDomainSourceModelTypes(); - sortSourceTypes(sourceTypes); - sources = locateMetaDataSourceInstances(sourceTypes, model); - mergeModel(model, sources); + this._model = model; + _sourceTypes = loadDomainSourceModelTypes(); + sortSourceTypes(_sourceTypes); + _sources = locateMetaDataSourceInstances(_sourceTypes, model); + mergeModel(model, _sources); } /* (non-Javadoc) @@ -57,12 +57,12 @@ public class DomainLoadingStrategy implements IDomainLoadingStrategy, IMetaDataO */ public void reload() throws ModelNotSetException { System.out.println("reload");//debug - if (model == null) + if (_model == null) throw new ModelNotSetException(); removeOldLocatorObservers(); - sources = locateMetaDataSourceInstances(sourceTypes, model); - mergeModel(model, sources); + _sources = locateMetaDataSourceInstances(_sourceTypes, _model); + mergeModel(_model, _sources); } /** @@ -148,8 +148,8 @@ public class DomainLoadingStrategy implements IDomainLoadingStrategy, IMetaDataO * @see org.eclipse.jst.jsf.common.metadata.internal.IMetaDataObserver#notifyMetadataChanged(org.eclipse.jst.jsf.common.metadata.internal.IMetaDataChangeNotificationEvent) */ public void notifyMetadataChanged(IMetaDataChangeNotificationEvent event) { - //for now, if any event occurs, we need to flush the model so that it will rebuild - model.setNeedsRefresh(); + //for now, if any event occurs, we need to flush the _model so that it will rebuild + _model.setNeedsRefresh(); } /* (non-Javadoc) @@ -157,14 +157,14 @@ public class DomainLoadingStrategy implements IDomainLoadingStrategy, IMetaDataO */ public void cleanup(){ removeOldLocatorObservers(); - sources = null; - sourceTypes = null; - model = null; + _sources = null; + _sourceTypes = null; + _model = null; } private void removeOldLocatorObservers(){ - if (sources != null){ - for (Iterator it= sources.iterator();it.hasNext();){ + if (_sources != null){ + for (Iterator it= _sources.iterator();it.hasNext();){ IMetaDataSourceModelProvider provider = (IMetaDataSourceModelProvider)it.next(); IMetaDataLocator locator = provider.getLocator(); locator.removeObserver(this); diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/DomainSourceModelTypeDescriptor.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/DomainSourceModelTypeDescriptor.java index a0a024be1..36183ef75 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/DomainSourceModelTypeDescriptor.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/DomainSourceModelTypeDescriptor.java @@ -97,6 +97,9 @@ public class DomainSourceModelTypeDescriptor { return domain; } + /** + * @return singleton instance of the {@link IDomainSourceModelType} + */ public IDomainSourceModelType getInstance(){ if (_instance == null){ _instance = newInstance(); @@ -111,6 +114,9 @@ public class DomainSourceModelTypeDescriptor { return new DomainSourceModelTypeImpl(); } + /** + * Internal class implementing {@link IDomainSourceModelType} + */ class DomainSourceModelTypeImpl implements IDomainSourceModelType{ private Set translators; @@ -190,7 +196,7 @@ public class DomainSourceModelTypeDescriptor { Iterator/*<DomainSourceModelTranslatorDescriptor>*/it = translatorDescriptors.iterator(); while (it.hasNext()){ DomainSourceModelTranslatorDescriptor d = (DomainSourceModelTranslatorDescriptor)it.next(); - Class klass = JSFCommonPlugin.loadClass(d.translator, d.bundleId); + Class klass = JSFCommonPlugin.loadClass(d.getTranslator(), d.getBundleId()); try { translators.add(klass.newInstance()); } catch (InstantiationException e) { @@ -207,16 +213,29 @@ public class DomainSourceModelTypeDescriptor { } /** - * Implements a descriptor for DomainSourceModelTranslators + * Internal class implementing a descriptor for DomainSourceModelTranslators */ class DomainSourceModelTranslatorDescriptor { - private String translator; - private String bundleId; + private String _translator; + private String _bundleId; + /** + * Constructor + * @param translator + * @param bundleId + */ public DomainSourceModelTranslatorDescriptor(String translator, String bundleId) { - this.translator = translator; - this.bundleId = bundleId; + this._translator = translator; + this._bundleId = bundleId; + } + + String getTranslator(){ + return _translator; + } + + String getBundleId(){ + return _bundleId; } } diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IClassLoaderProvider.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IClassLoaderProvider.java index 841bf52f9..6c8169616 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IClassLoaderProvider.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IClassLoaderProvider.java @@ -10,6 +10,9 @@ *******************************************************************************/ package org.eclipse.jst.jsf.common.metadata.internal; +/** + * Provides class loading by using the plugin's classloader that defined an item of metadata + */ public interface IClassLoaderProvider { /** * @param className diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IDomainLoadingStrategy.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IDomainLoadingStrategy.java index 6bd4bcb4b..ee21e6249 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IDomainLoadingStrategy.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IDomainLoadingStrategy.java @@ -28,6 +28,7 @@ public interface IDomainLoadingStrategy { /** * Reload a merged "standard" metadata model. * Allows for some optimization for reload. + * @throws ModelNotSetException * */ public void reload() throws ModelNotSetException; diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IDomainSourceModelType.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IDomainSourceModelType.java index 89138e9b7..296c4a7a2 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IDomainSourceModelType.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IDomainSourceModelType.java @@ -14,13 +14,22 @@ package org.eclipse.jst.jsf.common.metadata.internal; import java.util.Set; /** - * Binds a domain of metatdata to a source model type which is defined by a {@link IMetaDataLocator} + * Binds a domain of metadata to a source model type which is defined by a {@link IMetaDataLocator} * and set of {@link IMetaDataTranslator}s * Not intended to be implemented by clients. Created from ext-pts. */ public interface IDomainSourceModelType { + /** + * @return domain id + */ public String getDomain(); + /** + * @return IMetaDataLocator + */ public IMetaDataLocator getLocator(); // public int getOrdinal(); + /** + * @return set of {@link IMetaDataTranslator}s for the domain source model type + */ public Set/*<IMetaDataTranslator>*/ getTranslators(); } diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IImageDescriptorProvider.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IImageDescriptorProvider.java index 635f571fd..9405a6a64 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IImageDescriptorProvider.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IImageDescriptorProvider.java @@ -12,6 +12,10 @@ package org.eclipse.jst.jsf.common.metadata.internal; import org.eclipse.jface.resource.ImageDescriptor; +/** + * Provides image descriptors relative to the plugin that provided the image metadata + * + */ public interface IImageDescriptorProvider { /** * @param imagePath diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IMetaDataChangeNotificationEvent.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IMetaDataChangeNotificationEvent.java index e08da6ee4..d14e19c8d 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IMetaDataChangeNotificationEvent.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IMetaDataChangeNotificationEvent.java @@ -11,6 +11,10 @@ ********************************************************************************/ package org.eclipse.jst.jsf.common.metadata.internal; +/** + * Experimental and not used at the moment. + * + */ public interface IMetaDataChangeNotificationEvent { //change to enums if we do Java5 public static final int ADDED = 1; diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IMetaDataModelMergeAssistant.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IMetaDataModelMergeAssistant.java index 371cb1167..e7ebc0138 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IMetaDataModelMergeAssistant.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IMetaDataModelMergeAssistant.java @@ -53,7 +53,13 @@ public interface IMetaDataModelMergeAssistant { */ public void setMergeComplete(); + /** + * @param mds - {@link IMetaDataSourceModelProvider} + */ public void setSourceModelProvider(IMetaDataSourceModelProvider mds); + /** + * @return {@link IMetaDataSourceModelProvider} for current operation + */ public IMetaDataSourceModelProvider getSourceModelProvider(); diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IMetaDataObservable.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IMetaDataObservable.java index d38f4f8cc..89c06240b 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IMetaDataObservable.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IMetaDataObservable.java @@ -12,7 +12,8 @@ package org.eclipse.jst.jsf.common.metadata.internal; /** - * Allows {@link IMetaDataObserver}s to observe changes + * Allows {@link IMetaDataObserver}s to observe changes. + * Experimental. * */ public interface IMetaDataObservable { diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IResourceBundleProvider.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IResourceBundleProvider.java index 148cc2433..640da3540 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IResourceBundleProvider.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IResourceBundleProvider.java @@ -12,6 +12,9 @@ package org.eclipse.jst.jsf.common.metadata.internal; import java.util.ResourceBundle; +/** + * Provides the resource bundle from the plugin that defined an item of metadata. + */ public interface IResourceBundleProvider { /** * @return ResourceBundle - implementers should eat exceptions and return null whenever resourceBundle cannot be returned diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IStandardMetaDataSourceInfo.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IStandardMetaDataSourceInfo.java index 7febe3719..02270a31d 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IStandardMetaDataSourceInfo.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/IStandardMetaDataSourceInfo.java @@ -12,13 +12,17 @@ package org.eclipse.jst.jsf.common.metadata.internal; +/** + * Represents the metadata file defined by the StandardMetaDataFile extension-point + * Not intended to be implemented by clients + */ public interface IStandardMetaDataSourceInfo { /** * @return location of metadata file that the locator class will use */ public String getLocation(); /** - * @return bundle id of plugin defining the annotation file + * @return bundle id of plugin defining the metadata file */ public String getBundleId(); /** diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/MetaDataChangeNotificationEvent.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/MetaDataChangeNotificationEvent.java index 0527126b7..8ecc17df6 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/MetaDataChangeNotificationEvent.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/MetaDataChangeNotificationEvent.java @@ -22,20 +22,35 @@ public class MetaDataChangeNotificationEvent implements private IMetaDataLocator _locator; private int _type; + /** + * Constructor + * @param locator + * @param uri + * @param type + */ public MetaDataChangeNotificationEvent(IMetaDataLocator locator, String uri, int type){ this._locator = locator; this._uri = uri; this._type = type; } + /* (non-Javadoc) + * @see org.eclipse.jst.jsf.common.metadata.internal.IMetaDataChangeNotificationEvent#getEventType() + */ public int getEventType() { return _type; } + /* (non-Javadoc) + * @see org.eclipse.jst.jsf.common.metadata.internal.IMetaDataChangeNotificationEvent#getLocator() + */ public IMetaDataLocator getLocator() { return _locator; } + /* (non-Javadoc) + * @see org.eclipse.jst.jsf.common.metadata.internal.IMetaDataChangeNotificationEvent#getURI() + */ public String getURI() { return _uri; } diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/MetaDataLocatorFactory.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/MetaDataLocatorFactory.java index aac18681b..a9f4b4001 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/MetaDataLocatorFactory.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/MetaDataLocatorFactory.java @@ -24,6 +24,9 @@ import org.eclipse.jst.jsf.common.JSFCommonPlugin; public class MetaDataLocatorFactory { private static MetaDataLocatorFactory INSTANCE = null; + /** + * @return singleton instance of the MetaDataLocatorFactory + */ public synchronized static MetaDataLocatorFactory getInstance(){ if (INSTANCE == null){ INSTANCE = new MetaDataLocatorFactory(); @@ -40,6 +43,11 @@ public class MetaDataLocatorFactory { return _locators; } + /** + * @param locatorClassName + * @param bundleId + * @return IMetaDataLocator + */ public IMetaDataLocator getLocator(String locatorClassName, String bundleId){ String key = getKey(locatorClassName, bundleId); IMetaDataLocator locator = (IMetaDataLocator)getLocators().get(key); @@ -65,6 +73,9 @@ public class MetaDataLocatorFactory { return buf.toString(); } + /** + * Stops and disposes all locators + */ public void dispose(){ for (Iterator it=getLocators().values().iterator();it.hasNext();){ IMetaDataLocator locator = (IMetaDataLocator)it.next(); diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/MetaDataModel.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/MetaDataModel.java index c25f51250..5554ab7b8 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/MetaDataModel.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/MetaDataModel.java @@ -62,6 +62,9 @@ public class MetaDataModel { // visitor.visit((Model)getRoot()); // } + /** + * @return true if the model is null or is not, in fact, a {@link Model} + */ public boolean isEmpty() { if (root == null || !(root instanceof Model)) return true; diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/ModelKeyDescriptor.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/ModelKeyDescriptor.java index fa7da9251..b08227701 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/ModelKeyDescriptor.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/ModelKeyDescriptor.java @@ -13,11 +13,22 @@ package org.eclipse.jst.jsf.common.metadata.internal; import org.eclipse.core.resources.IProject; +/** + * Meta data model key descriptor used to lazily load a model when it is required + * + */ public class ModelKeyDescriptor { private IProject project; private String domain; private String uri; private String key; + + /** + * Constructor + * @param project + * @param domain + * @param uri + */ public ModelKeyDescriptor(IProject project, String domain, String uri){ this.project = project; this.domain = domain; @@ -28,18 +39,30 @@ public class ModelKeyDescriptor { key = buf.toString(); } + /** + * @return domain id + */ public String getDomain(){ return domain; } + /** + * @return model uri + */ public String getUri(){ return uri; } + /** + * @return project + */ public IProject getProject(){ return project; } + /* (non-Javadoc) + * @see java.lang.Object#toString() + */ public String toString(){ return key; } diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/ResourceBundleHelper.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/ResourceBundleHelper.java index 882b0d505..229bc7db3 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/ResourceBundleHelper.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/ResourceBundleHelper.java @@ -21,12 +21,29 @@ import java.util.ResourceBundle; import org.eclipse.core.runtime.FileLocator; +/** + * ResourceBundleHelper + * + */ public class ResourceBundleHelper { + /** + * @param resourceURI + * @return ResourceBundle + * @throws MalformedURLException - may return null + * @throws IOException + */ public static ResourceBundle getResourceBundle(String resourceURI) throws MalformedURLException, IOException { return getResourceBundle(resourceURI, Locale.getDefault()); } + /** + * @param resourceURI + * @param targetLocale + * @return ResourceBundle - may return null + * @throws MalformedURLException + * @throws IOException + */ public static ResourceBundle getResourceBundle(String resourceURI, Locale targetLocale) throws MalformedURLException, IOException { // try to load bundle from the location specified in the resourceURI // we make the assumption that the resourceURI points to the local diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/StandardAnnotationFilesTranslator.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/StandardAnnotationFilesTranslator.java index 719c331cc..79c9c71d5 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/StandardAnnotationFilesTranslator.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/StandardAnnotationFilesTranslator.java @@ -19,6 +19,10 @@ import org.eclipse.jst.jsf.common.metadata.Model; import org.eclipse.jst.jsf.common.metadata.Trait; +/** + * A 'null' translation of a metadata file. Entities and traits are not transformed. + * + */ public class StandardAnnotationFilesTranslator implements IMetaDataTranslator { public void translate(IMetaDataModelMergeAssistant assistant) {//TODO: throw proper errors @@ -40,6 +44,11 @@ public class StandardAnnotationFilesTranslator implements IMetaDataTranslator { } } + /** + * Add entity and any children + * @param assistant + * @param entity + */ protected void traverseAndAdd(IMetaDataModelMergeAssistant assistant, final Entity entity){ assistant.addEntity(entity); diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/StandardMetaDataFileInfo.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/StandardMetaDataFileInfo.java index 886c34eac..5dfb331df 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/StandardMetaDataFileInfo.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/StandardMetaDataFileInfo.java @@ -20,6 +20,12 @@ public final class StandardMetaDataFileInfo implements IStandardMetaDataSourceIn private String fileLocatorClassname; private String bundleId; + /** + * Constructor + * @param fileLocation + * @param bundleId + * @param fileLocatorClassname + */ public StandardMetaDataFileInfo( String fileLocation, String bundleId, String fileLocatorClassname) { this.fileLocation = fileLocation.trim(); this.bundleId = bundleId.trim(); @@ -53,12 +59,17 @@ public final class StandardMetaDataFileInfo implements IStandardMetaDataSourceIn public String getBundleId() { return bundleId; } - - -// public URI getLocation() { -// // TODO Auto-generated method stub -// return URI.createPlatformResourceURI(bundleId + "/" + fileLocation, false); -// } - + public String toString(){ + StringBuffer buf = new StringBuffer("StandardMetaDataFileInfo"); + buf.append(": "); + buf.append(bundleId); + buf.append("/"); + buf.append(fileLocation); + if (getLocatorClassname() != null){ + buf.append(": "); + buf.append(getLocatorClassname()); + } + return buf.toString(); + } } diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/StandardMetaDataFileRegistry.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/StandardMetaDataFileRegistry.java index 88dcd09f9..240aa9f3d 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/StandardMetaDataFileRegistry.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/StandardMetaDataFileRegistry.java @@ -84,7 +84,7 @@ public final class StandardMetaDataFileRegistry { } /** - * Implementation of IMetaDataSourceModelProvider for "standard" metadata sources + * Internal implementation of IMetaDataSourceModelProvider for "standard" metadata sources * */ class StandardMetaDataFilesProvider implements IMetaDataSourceModelProvider { @@ -94,6 +94,11 @@ class StandardMetaDataFilesProvider implements IMetaDataSourceModelProvider { private IMetaDataLocator locator; private StandardMetaDataSourceFileLocator fileLocator = null; + /** + * Constructor + * @param info + * @param uri + */ StandardMetaDataFilesProvider(IStandardMetaDataSourceInfo info, String uri){ this.info = info; } @@ -108,9 +113,9 @@ class StandardMetaDataFilesProvider implements IMetaDataSourceModelProvider { try { fileLocator = (StandardMetaDataSourceFileLocator)klass.newInstance(); } catch (InstantiationException e) { - JSFCommonPlugin.log(IStatus.ERROR, "InstantiationException: StandardMetaDataFilesProvider.getFileLocator()", e); + JSFCommonPlugin.log(IStatus.ERROR, "InstantiationException: StandardMetaDataFilesProvider.getFileLocator()", e); //$NON-NLS-1$ } catch (IllegalAccessException e) { - JSFCommonPlugin.log(IStatus.ERROR, "IllegalAccessException: StandardMetaDataFilesProvider.getFileLocator()", e); + JSFCommonPlugin.log(IStatus.ERROR, "IllegalAccessException: StandardMetaDataFilesProvider.getFileLocator()", e); //$NON-NLS-1$ } } if (fileLocator != null) @@ -148,13 +153,13 @@ class StandardMetaDataFilesProvider implements IMetaDataSourceModelProvider { } catch (FileNotFoundException e){ JSFCommonPlugin.log(IStatus.ERROR, e.getLocalizedMessage()); } catch (IOException e) { - JSFCommonPlugin.log(IStatus.ERROR,"IOException(1): StandardMetaDataFilesProvider.getSourceModel()", e); + JSFCommonPlugin.log(IStatus.ERROR,"IOException(1): StandardMetaDataFilesProvider.getSourceModel()", e); //$NON-NLS-1$ } finally { if (inputStream != null){ try { inputStream.close(); } catch (IOException e) { - JSFCommonPlugin.log( IStatus.ERROR,"IOException (2): StandardMetaDataFilesProvider.getSourceModel()", e); + JSFCommonPlugin.log( IStatus.ERROR,"IOException (2): StandardMetaDataFilesProvider.getSourceModel()", e); //$NON-NLS-1$ } } } @@ -209,13 +214,13 @@ class StandardMetaDataFilesProvider implements IMetaDataSourceModelProvider { private String getImageBase(){ if (imageBase == null){ Model aModel = (Model)getSourceModel(); - Trait t = MetaDataQueryHelper.getTrait(aModel, "images-base-path"); + Trait t = MetaDataQueryHelper.getTrait(aModel, "images-base-path"); //$NON-NLS-1$ if (t == null){ - imageBase = ""; + imageBase = ""; //$NON-NLS-1$ } else { imageBase = TraitValueHelper.getValueAsString(t); if (imageBase != null && imageBase.length() > 0){ - imageBase = imageBase +"/"; + imageBase = imageBase +"/"; //$NON-NLS-1$ } } } diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/StandardModelFactory.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/StandardModelFactory.java index 00340e96d..004ef89d6 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/StandardModelFactory.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/StandardModelFactory.java @@ -34,11 +34,13 @@ import org.eclipse.jst.jsf.common.metadata.query.IMetaDataModelContext; */ public class StandardModelFactory { private static StandardModelFactory INSTANCE; -// private static final String EXT_MD = ExtendedMetaData.ANNOTATION_URI; private ExtendedMetaData extendedMetaData; private ResourceSet resourceSet; + /** + * @return singleton instance of the metadata model factory + */ public synchronized static StandardModelFactory getInstance(){ if (INSTANCE == null){ INSTANCE = new StandardModelFactory(); @@ -93,6 +95,7 @@ public class StandardModelFactory { /** * @param inputStream + * @param provider * @return the root of the standard model from the resource as an EList * @throws IOException */ @@ -120,16 +123,5 @@ public class StandardModelFactory { // options.put(XMLResource.OPTION_DOM_USE_NAMESPACES_IN_SCOPE, Boolean.TRUE); } -// private Map getOptions(Resource resource) { -// Map options = new HashMap/*<String, Object>*/(); -//// options.put(XMLResource.OPTION_SAVE_TYPE_INFORMATION, true); -// options.put(XMLResource.OPTION_SCHEMA_LOCATION, Boolean.TRUE); -// options.put(XMLResource.OPTION_EXTENDED_META_DATA, extendedMetaData); -// options.put(XMLResource.OPTION_RESOURCE_HANDLER, resource); -// options.put(XMLResource.OPTION_LAX_FEATURE_PROCESSING, Boolean.TRUE); -// options.put(XMLResource.OPTION_RECORD_UNKNOWN_FEATURE, Boolean.TRUE); -//// options.put(XMLResource.OPTION_DOM_USE_NAMESPACES_IN_SCOPE, Boolean.TRUE); -// return options; -// } } diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/impl/EntityGroupImpl.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/impl/EntityGroupImpl.java index ce7c18582..9343b62de 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/impl/EntityGroupImpl.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/impl/EntityGroupImpl.java @@ -2,7 +2,7 @@ * <copyright> * </copyright> * - * $Id: EntityGroupImpl.java,v 1.3 2007/04/16 19:54:10 itrimble Exp $ + * $Id: EntityGroupImpl.java,v 1.4 2007/05/11 17:54:55 gkessler Exp $ */ package org.eclipse.jst.jsf.common.metadata.internal.impl; @@ -25,6 +25,7 @@ public class EntityGroupImpl extends EntityImpl implements EntityGroup { * <!-- end-user-doc --> * @generated */ + @SuppressWarnings("hiding") public static final String copyright = "Copyright (c) 2007 Oracle Corporation"; /** diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/impl/MetadataFactoryImpl.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/impl/MetadataFactoryImpl.java index 7f4fe4ac4..ca0430741 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/impl/MetadataFactoryImpl.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/impl/MetadataFactoryImpl.java @@ -2,7 +2,7 @@ * <copyright> * </copyright> * - * $Id: MetadataFactoryImpl.java,v 1.3 2007/04/16 19:54:10 itrimble Exp $ + * $Id: MetadataFactoryImpl.java,v 1.4 2007/05/11 17:54:55 gkessler Exp $ */ package org.eclipse.jst.jsf.common.metadata.internal.impl; @@ -43,6 +43,7 @@ public class MetadataFactoryImpl extends EFactoryImpl implements MetadataFactory * Creates the default factory implementation. * <!-- begin-user-doc --> * <!-- end-user-doc --> + * @return MetadataFactory * @generated */ public static MetadataFactory init() { @@ -170,6 +171,9 @@ public class MetadataFactoryImpl extends EFactoryImpl implements MetadataFactory /** * <!-- begin-user-doc --> * <!-- end-user-doc --> + * @param eDataType IMetaDataSourceModelProvider + * @param initialValue + * @return IMetaDataSourceModelProvider * @generated */ public IMetaDataSourceModelProvider createIMetaDataSourceModelProviderFromString(EDataType eDataType, String initialValue) { @@ -179,6 +183,9 @@ public class MetadataFactoryImpl extends EFactoryImpl implements MetadataFactory /** * <!-- begin-user-doc --> * <!-- end-user-doc --> + * @param eDataType + * @param instanceValue + * @return String * @generated */ public String convertIMetaDataSourceModelProviderToString(EDataType eDataType, Object instanceValue) { @@ -188,6 +195,9 @@ public class MetadataFactoryImpl extends EFactoryImpl implements MetadataFactory /** * <!-- begin-user-doc --> * <!-- end-user-doc --> + * @param eDataType + * @param initialValue + * @return ModelKeyDescriptor * @generated */ public ModelKeyDescriptor createModelContextFromString(EDataType eDataType, String initialValue) { @@ -197,6 +207,9 @@ public class MetadataFactoryImpl extends EFactoryImpl implements MetadataFactory /** * <!-- begin-user-doc --> * <!-- end-user-doc --> + * @param eDataType + * @param instanceValue + * @return String * @generated */ public String convertModelContextToString(EDataType eDataType, Object instanceValue) { @@ -215,6 +228,7 @@ public class MetadataFactoryImpl extends EFactoryImpl implements MetadataFactory /** * <!-- begin-user-doc --> * <!-- end-user-doc --> + * @return MetadataPackage * @deprecated * @generated */ diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/impl/MetadataPackageImpl.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/impl/MetadataPackageImpl.java index 47fb35e71..7f9d582c9 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/impl/MetadataPackageImpl.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/impl/MetadataPackageImpl.java @@ -2,7 +2,7 @@ * <copyright> * </copyright> * - * $Id: MetadataPackageImpl.java,v 1.5 2007/04/16 19:54:10 itrimble Exp $ + * $Id: MetadataPackageImpl.java,v 1.6 2007/05/11 17:54:55 gkessler Exp $ */ package org.eclipse.jst.jsf.common.metadata.internal.impl; @@ -146,6 +146,7 @@ public class MetadataPackageImpl extends EPackageImpl implements MetadataPackage * already been initialized. * <!-- begin-user-doc --> * <!-- end-user-doc --> + * @return MetadataPackage * @see #eNS_URI * @see #createPackageContents() * @see #initializePackageContents() @@ -589,6 +590,7 @@ public class MetadataPackageImpl extends EPackageImpl implements MetadataPackage * <!-- end-user-doc --> * @generated */ + @SuppressWarnings("cast") protected void createGenModelAnnotations() { String source = "http://www.eclipse.org/emf/2002/GenModel"; addAnnotation diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/impl/ModelImpl.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/impl/ModelImpl.java index f6ad57eaf..8a5652c5f 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/impl/ModelImpl.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/impl/ModelImpl.java @@ -2,7 +2,7 @@ * <copyright> * </copyright> * - * $Id: ModelImpl.java,v 1.3 2007/04/16 19:54:10 itrimble Exp $ + * $Id: ModelImpl.java,v 1.4 2007/05/11 17:54:55 gkessler Exp $ */ package org.eclipse.jst.jsf.common.metadata.internal.impl; @@ -41,6 +41,7 @@ public class ModelImpl extends EntityImpl implements Model { * <!-- end-user-doc --> * @generated */ + @SuppressWarnings("hiding") public static final String copyright = "Copyright (c) 2007 Oracle Corporation"; /** diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/impl/TraitImpl.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/impl/TraitImpl.java index ad9f054fb..0c2d1f84d 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/impl/TraitImpl.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/impl/TraitImpl.java @@ -2,7 +2,7 @@ * <copyright> * </copyright> * - * $Id: TraitImpl.java,v 1.3 2007/04/16 19:54:10 itrimble Exp $ + * $Id: TraitImpl.java,v 1.4 2007/05/11 17:54:55 gkessler Exp $ */ package org.eclipse.jst.jsf.common.metadata.internal.impl; @@ -125,6 +125,9 @@ public class TraitImpl extends EObjectImpl implements Trait { /** * <!-- begin-user-doc --> * <!-- end-user-doc --> + * @param newValue + * @param msgs + * @return NotificationChain * @generated */ public NotificationChain basicSetValue(EObject newValue, NotificationChain msgs) { @@ -311,7 +314,7 @@ public class TraitImpl extends EObjectImpl implements Trait { return result.toString(); } - public boolean equals(Object value){ + public boolean equals(@SuppressWarnings("hiding")Object value){ if (!(value instanceof String)) return super.equals(value); diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/util/MetadataResourceImpl.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/util/MetadataResourceImpl.java index 21e67b97e..a82e0dac9 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/util/MetadataResourceImpl.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/util/MetadataResourceImpl.java @@ -2,7 +2,7 @@ * <copyright> * </copyright> * - * $Id: MetadataResourceImpl.java,v 1.6 2007/04/16 19:54:01 itrimble Exp $ + * $Id: MetadataResourceImpl.java,v 1.7 2007/05/11 17:54:56 gkessler Exp $ */ package org.eclipse.jst.jsf.common.metadata.internal.util; @@ -31,31 +31,17 @@ import org.eclipse.jst.jsf.common.metadata.internal.IMetaDataSourceModelProvider */ public class MetadataResourceImpl extends XMLResourceImpl implements XMLResource.ResourceHandler { - protected IMetaDataSourceModelProvider _provider; - - public MetadataResourceImpl(IMetaDataSourceModelProvider provider){ - super(); - _provider = provider; - } - /** - * Override createXMLHelper so that MetadataPackage.eINSTANCE is used for the NoNamespace package - * @generated NOT - */ - protected XMLHelper createXMLHelper() { - return new XMLHelperImpl(){ - public EPackage getNoNamespacePackage() { - return MetadataPackage.eINSTANCE; - } - }; - } - /** * <!-- begin-user-doc --> * <!-- end-user-doc --> * @generated */ public static final String copyright = "Oracle inc."; - + + /** + * IMetaDataSourceModelProvider + */ + protected IMetaDataSourceModelProvider _provider; /** * Creates an instance of the resource. * <!-- begin-user-doc --> @@ -67,9 +53,33 @@ public class MetadataResourceImpl extends XMLResourceImpl implements XMLResource super(uri); } + /** + * Constructor + */ public MetadataResourceImpl() { super(); } + + + /** + * Constructorb + * @param provider + */ + public MetadataResourceImpl(IMetaDataSourceModelProvider provider){ + super(); + _provider = provider; + } + /** + * Override createXMLHelper so that MetadataPackage.eINSTANCE is used for the NoNamespace package + * @generated NOT + */ + protected XMLHelper createXMLHelper() { + return new XMLHelperImpl(){ + public EPackage getNoNamespacePackage() { + return MetadataPackage.eINSTANCE; + } + }; + } public void postLoad(XMLResource resource, InputStream inputStream, Map options) { diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/util/MetadataSwitch.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/util/MetadataSwitch.java index ec618581f..39efb15a7 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/util/MetadataSwitch.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/internal/util/MetadataSwitch.java @@ -2,7 +2,7 @@ * <copyright> * </copyright> * - * $Id: MetadataSwitch.java,v 1.4 2007/04/16 19:54:01 itrimble Exp $ + * $Id: MetadataSwitch.java,v 1.5 2007/05/11 17:54:56 gkessler Exp $ */ package org.eclipse.jst.jsf.common.metadata.internal.util; @@ -65,6 +65,7 @@ public class MetadataSwitch { * Calls <code>caseXXX</code> for each class of the model until one returns a non null result; it yields that result. * <!-- begin-user-doc --> * <!-- end-user-doc --> + * @param theEObject * @return the first non-null result returned by a <code>caseXXX</code> call. * @generated */ @@ -76,6 +77,8 @@ public class MetadataSwitch { * Calls <code>caseXXX</code> for each class of the model until one returns a non null result; it yields that result. * <!-- begin-user-doc --> * <!-- end-user-doc --> + * @param theEClass + * @param theEObject * @return the first non-null result returned by a <code>caseXXX</code> call. * @generated */ @@ -96,6 +99,8 @@ public class MetadataSwitch { * Calls <code>caseXXX</code> for each class of the model until one returns a non null result; it yields that result. * <!-- begin-user-doc --> * <!-- end-user-doc --> + * @param classifierID + * @param theEObject * @return the first non-null result returned by a <code>caseXXX</code> call. * @generated */ diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/query/IEntityQueryVisitor.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/query/IEntityQueryVisitor.java index af67fc22d..ccdc35347 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/query/IEntityQueryVisitor.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/query/IEntityQueryVisitor.java @@ -13,6 +13,10 @@ package org.eclipse.jst.jsf.common.metadata.query; import org.eclipse.jst.jsf.common.metadata.Entity; +/** + * Entity querying interface + * + */ public interface IEntityQueryVisitor extends IEntityVisitor{ /** * @param initialEntityContext diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/query/IMetaDataVisitor.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/query/IMetaDataVisitor.java index 8626ccf50..7ed06be32 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/query/IMetaDataVisitor.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/query/IMetaDataVisitor.java @@ -16,5 +16,8 @@ package org.eclipse.jst.jsf.common.metadata.query; */ public abstract interface IMetaDataVisitor { // API: contract? + /** + * @return true if visitor has recognized that visiting should stop + */ public boolean stopVisiting(); } diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/query/SimpleMetaDataQueryVisitorImpl.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/query/SimpleMetaDataQueryVisitorImpl.java index 43a2d0412..a6376e9e3 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/query/SimpleMetaDataQueryVisitorImpl.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/query/SimpleMetaDataQueryVisitorImpl.java @@ -27,7 +27,7 @@ import org.eclipse.jst.jsf.common.metadata.Trait; */ public class SimpleMetaDataQueryVisitorImpl implements IEntityQueryVisitor, ITraitQueryVisitor { - private String traitQuery; + private String _traitQuery; private SearchControl control; private boolean _stop; @@ -59,7 +59,7 @@ public class SimpleMetaDataQueryVisitorImpl implements IEntityQueryVisitor, ITra resetQuery(); if (entity != null){ - this.traitQuery = traitQuery; + this._traitQuery = traitQuery; for (Iterator/*<Trait>*/ it=entity.getTraits().iterator();it.hasNext();){ Trait t = (Trait)it.next(); t.accept(this); @@ -74,7 +74,7 @@ public class SimpleMetaDataQueryVisitorImpl implements IEntityQueryVisitor, ITra * @see org.eclipse.jst.jsf.common.metadata.query.ITraitVisitor#visit(org.eclipse.jst.jsf.common.metadata.Trait) */ public void visit(Trait trait) { - if (trait.equals(traitQuery)) + if (trait.equals(_traitQuery)) getTraitResultSet().addItem(trait); checkShouldStopVisitingTraits(); @@ -170,6 +170,10 @@ public class SimpleMetaDataQueryVisitorImpl implements IEntityQueryVisitor, ITra private String entityKey; private EntityStack stack; + /** + * Constructor + * @param entityKey + */ public EntityQueryComparator(String entityKey){ this.entityKey = entityKey; stack = new EntityStack(); @@ -180,6 +184,9 @@ public class SimpleMetaDataQueryVisitorImpl implements IEntityQueryVisitor, ITra return entityKey.compareTo(getRelativeId()); } + /** + * Pop stack + */ public void popContext(){ stack.pop(); } @@ -210,6 +217,9 @@ public class SimpleMetaDataQueryVisitorImpl implements IEntityQueryVisitor, ITra */ private static final long serialVersionUID = -6010267544968175003L; + /** + * Constructor + */ public EntityStack(){ super(); } diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/traittypes/traittypes/TraitTypesPackage.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/traittypes/traittypes/TraitTypesPackage.java index 95f48632c..f511e1a7b 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/traittypes/traittypes/TraitTypesPackage.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/traittypes/traittypes/TraitTypesPackage.java @@ -216,6 +216,7 @@ public interface TraitTypesPackage extends EPackage { * @see org.eclipse.jst.jsf.common.metadata.traittypes.traittypes.internal.impl.TraitTypesPackageImpl#getListOfValues() * @generated */ + @SuppressWarnings("hiding") EClass LIST_OF_VALUES = eINSTANCE.getListOfValues(); /** @@ -224,6 +225,7 @@ public interface TraitTypesPackage extends EPackage { * <!-- end-user-doc --> * @generated */ + @SuppressWarnings("hiding") EReference LIST_OF_VALUES__ENTRIES = eINSTANCE.getListOfValues_Entries(); /** @@ -234,7 +236,8 @@ public interface TraitTypesPackage extends EPackage { * @see org.eclipse.jst.jsf.common.metadata.traittypes.traittypes.internal.impl.TraitTypesPackageImpl#getSetGenerator() * @generated */ - EClass SET_GENERATOR = eINSTANCE.getSetGenerator(); + @SuppressWarnings("hiding") + EClass SET_GENERATOR = eINSTANCE.getSetGenerator(); /** * The meta object literal for the '<em><b>Algorithm</b></em>' attribute feature. @@ -242,7 +245,8 @@ public interface TraitTypesPackage extends EPackage { * <!-- end-user-doc --> * @generated */ - EAttribute SET_GENERATOR__ALGORITHM = eINSTANCE.getSetGenerator_Algorithm(); + @SuppressWarnings("hiding") + EAttribute SET_GENERATOR__ALGORITHM = eINSTANCE.getSetGenerator_Algorithm(); /** * The meta object literal for the '<em><b>Expression</b></em>' attribute feature. @@ -250,7 +254,8 @@ public interface TraitTypesPackage extends EPackage { * <!-- end-user-doc --> * @generated */ - EAttribute SET_GENERATOR__EXPRESSION = eINSTANCE.getSetGenerator_Expression(); + @SuppressWarnings("hiding") + EAttribute SET_GENERATOR__EXPRESSION = eINSTANCE.getSetGenerator_Expression(); } diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/traittypes/traittypes/internal/impl/TraitTypesFactoryImpl.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/traittypes/traittypes/internal/impl/TraitTypesFactoryImpl.java index 4ef14bf59..6aa6dfc2b 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/traittypes/traittypes/internal/impl/TraitTypesFactoryImpl.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/traittypes/traittypes/internal/impl/TraitTypesFactoryImpl.java @@ -2,7 +2,7 @@ * <copyright> * </copyright> * - * $Id: TraitTypesFactoryImpl.java,v 1.4 2007/04/16 19:54:01 itrimble Exp $ + * $Id: TraitTypesFactoryImpl.java,v 1.5 2007/05/11 17:54:57 gkessler Exp $ */ package org.eclipse.jst.jsf.common.metadata.traittypes.traittypes.internal.impl; @@ -34,6 +34,7 @@ public class TraitTypesFactoryImpl extends EFactoryImpl implements TraitTypesFac * Creates the default factory implementation. * <!-- begin-user-doc --> * <!-- end-user-doc --> + * @return TraitTypesFactory * @generated */ public static TraitTypesFactory init() { @@ -105,6 +106,7 @@ public class TraitTypesFactoryImpl extends EFactoryImpl implements TraitTypesFac /** * <!-- begin-user-doc --> * <!-- end-user-doc --> + * @return TraitTypesPackage * @deprecated * @generated */ diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/traittypes/traittypes/internal/impl/TraitTypesPackageImpl.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/traittypes/traittypes/internal/impl/TraitTypesPackageImpl.java index 640a5b490..e40e5ef5f 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/traittypes/traittypes/internal/impl/TraitTypesPackageImpl.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/traittypes/traittypes/internal/impl/TraitTypesPackageImpl.java @@ -2,7 +2,7 @@ * <copyright> * </copyright> * - * $Id: TraitTypesPackageImpl.java,v 1.4 2007/04/16 19:54:01 itrimble Exp $ + * $Id: TraitTypesPackageImpl.java,v 1.5 2007/05/11 17:54:57 gkessler Exp $ */ package org.eclipse.jst.jsf.common.metadata.traittypes.traittypes.internal.impl; @@ -91,6 +91,7 @@ public class TraitTypesPackageImpl extends EPackageImpl implements TraitTypesPac * already been initialized. * <!-- begin-user-doc --> * <!-- end-user-doc --> + * @return TraitTypesPackage * @see #eNS_URI * @see #createPackageContents() * @see #initializePackageContents() diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/traittypes/traittypes/internal/util/TraitTypesSwitch.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/traittypes/traittypes/internal/util/TraitTypesSwitch.java index 3e39a4d97..aeedcd780 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/traittypes/traittypes/internal/util/TraitTypesSwitch.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/common/metadata/traittypes/traittypes/internal/util/TraitTypesSwitch.java @@ -2,7 +2,7 @@ * <copyright> * </copyright> * - * $Id: TraitTypesSwitch.java,v 1.4 2007/04/16 19:54:18 itrimble Exp $ + * $Id: TraitTypesSwitch.java,v 1.5 2007/05/11 17:54:56 gkessler Exp $ */ package org.eclipse.jst.jsf.common.metadata.traittypes.traittypes.internal.util; @@ -58,6 +58,7 @@ public class TraitTypesSwitch { * Calls <code>caseXXX</code> for each class of the model until one returns a non null result; it yields that result. * <!-- begin-user-doc --> * <!-- end-user-doc --> + * @param theEObject * @return the first non-null result returned by a <code>caseXXX</code> call. * @generated */ @@ -69,6 +70,8 @@ public class TraitTypesSwitch { * Calls <code>caseXXX</code> for each class of the model until one returns a non null result; it yields that result. * <!-- begin-user-doc --> * <!-- end-user-doc --> + * @param theEClass + * @param theEObject * @return the first non-null result returned by a <code>caseXXX</code> call. * @generated */ @@ -89,6 +92,8 @@ public class TraitTypesSwitch { * Calls <code>caseXXX</code> for each class of the model until one returns a non null result; it yields that result. * <!-- begin-user-doc --> * <!-- end-user-doc --> + * @param classifierID + * @param theEObject * @return the first non-null result returned by a <code>caseXXX</code> call. * @generated */ diff --git a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/contentmodel/annotation/CMAnnotationSourceFileLocator.java b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/contentmodel/annotation/CMAnnotationSourceFileLocator.java index 2edbf9269..45a1cd2d6 100644 --- a/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/contentmodel/annotation/CMAnnotationSourceFileLocator.java +++ b/jsf/plugins/org.eclipse.jst.jsf.common/src/org/eclipse/jst/jsf/contentmodel/annotation/CMAnnotationSourceFileLocator.java @@ -28,6 +28,9 @@ import java.util.ResourceBundle; * @deprecated see common.metadata package */ public abstract class CMAnnotationSourceFileLocator{ + /** + * ICMAnnotationSourceFileInfo + */ protected ICMAnnotationSourceFileInfo fileInfo; /** |