Package org.eclipse.emfforms.internal.core.services.datatemplate

Class XmiTemplateProvider

  • All Implemented Interfaces:
    TemplateProvider
    public class XmiTemplateProvider
extends java.lang.Object
implements TemplateProvider
    Template provider that reads in templates from an extension point.
    Author:
    Lucas Koehler

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addLoaderServiceProvider​(TemplateLoaderService.Provider provider)
      Add a template loader service provider.
      boolean canProvideTemplates​(org.eclipse.emf.ecore.EObject owner, org.eclipse.emf.ecore.EReference reference)
      Queries whether the provider can provide templates that may be assigned to the given reference of the given owner object.
      java.util.Set<Template> provideTemplates​(org.eclipse.emf.ecore.EObject owner, org.eclipse.emf.ecore.EReference reference)
      Obtains templates wrapping objects that can be assigned to the given reference of the given owner object.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • XmiTemplateProvider

        public XmiTemplateProvider()

    • Method Detail

      • addLoaderServiceProvider

        public void addLoaderServiceProvider​(TemplateLoaderService.Provider provider)
        Add a template loader service provider.
        Parameters:
        provider - the provider to add
        Since:
        1.21

      • canProvideTemplates

        public boolean canProvideTemplates​(org.eclipse.emf.ecore.EObject owner,
                                   org.eclipse.emf.ecore.EReference reference)
        Description copied from interface: TemplateProvider
        Queries whether the provider can provide templates that may be assigned to the given reference of the given owner object.
        Specified by:
        canProvideTemplates in interface TemplateProvider
        Parameters:
        owner - the object owning a reference to be assigned from a template
        reference - a reference feature of the owner that is to be assigned from a template. If the reference is a containment then the owner would be the container of the template
        Returns:
        whether I have any templates to offer

      • provideTemplates

        public java.util.Set<Template> provideTemplates​(org.eclipse.emf.ecore.EObject owner,
                                                org.eclipse.emf.ecore.EReference reference)
        Description copied from interface: TemplateProvider
        Obtains templates wrapping objects that can be assigned to the given reference of the given owner object. This will only be called for an owner and reference for which the receiver previously answered true to an invocation of the TemplateProvider.canProvideTemplates(EObject, EReference) query.
        Specified by:
        provideTemplates in interface TemplateProvider
        Parameters:
        owner - the object owning a reference to be assigned from a template
        reference - a reference feature of the owner that is to be assigned from a template. If the reference is a containment then the owner would be the container of the template
        Returns:
        my available templates, or an empty set if none (never null)