Class AnnotationItemProviderAdapterFactory

Method Details

• getAssistant

  public BasicAnnotationValidator.Assistant getAssistant()

  Returns the assistant.

  The assistant is used by the implementations of AnnotationItemProvider and StringToStringMapEntryItemProvider.

  Returns:

  the assistant.

  See Also:

  • AnnotationItemProvider.SourcePropertyDescriptor#getAssistant()
  • AnnotationItemProvider.addReferencesPropertyDescriptor(Object)
  • StringToStringMapEntryItemProvider.createValuePropertyDescriptor(Map.Entry)
  • StringToStringMapEntryItemProvider.getKeyChoiceOfValues(Map.Entry)

• isShowInstances

  public boolean isShowInstances(Annotation annotation)

  Returns whether AnnotationItemProvider.SourcePropertyDescriptor#createPropertyValueWrapper(Object, Object) should show the modeled object in the property tree.

  This implementation always returns true if BasicAnnotationValidator.Assistant.getPropertyClasses(ModelElement) returns more than one class.

  Returns:

  whether the modeled objects should be explicitly shown in the property tree or should be omitted.

  See Also:

  • AnnotationItemProvider.SourcePropertyDescriptor#createPropertyValueWrapper(Object, Object)

• createAnnotationAdapter

  public Adapter createAnnotationAdapter()

  This creates an adapter for a Annotation by calling doCreateAnnotationAdapter(). Override this to create stateful adapters.

  Returns:

  the adapter or null.

• doCreateAnnotationAdapter

  protected Adapter doCreateAnnotationAdapter()

  Creates the adapter for an Annotation. Typically this will be a subclass of AnnotationItemProvider. Override this to create stateless adapters. This implementation always simply creates an AnnotationItemProvider.

  Returns:

  the adapter or null.

• createStringToStringMapEntryAdapter

  public Adapter createStringToStringMapEntryAdapter()

  This creates an adapter for a Map.Entry by calling doCreateStringToStringMapEntryAdapter(). Override this to create stateful adapters.

  Returns:

  the adapter or null.

• doCreateStringToStringMapEntryAdapter

  protected Adapter doCreateStringToStringMapEntryAdapter()

  Creates the adapter for an annotation's details. Typically this will be a subclass of StringToStringMapEntryItemProvider. Override this to create stateless adapters. This implementation always simply creates an StringToStringMapEntryItemProvider.

  Returns:

  the adapter or null.

• getRootAdapterFactory

  public ComposeableAdapterFactory getRootAdapterFactory()

  This returns the root adapter factory that contains this factory.

  Specified by:

  getRootAdapterFactory in interface ComposeableAdapterFactory

• setParentAdapterFactory

  public void setParentAdapterFactory(ComposedAdapterFactory parentAdapterFactory)

  This operation is not supported. An AnnotationItemProviderAdapterFactory should not be directly composed. Instead setParentAdapterFactory(EtypesItemProviderAdapterFactory) should be called to set the Etypes item provider adapter factory that uses this factory.

  Specified by:

  setParentAdapterFactory in interface ComposeableAdapterFactory

• setParentAdapterFactory

  public void setParentAdapterFactory(EtypesItemProviderAdapterFactory etypesItemProviderAdapterFactory)

  Sets the Etypes item provider adapter factory that uses this factory.

  Parameters:

  etypesItemProviderAdapterFactory - the Etypes item provider adapter factory that uses this factory.

• getResourceLocator

  public ResourceLocator getResourceLocator()

  Returns the resource locator uses by this annotation item provider adapter factory.

  Returns:

  the resource locator.

• isFactoryForType

  public boolean isFactoryForType(Object type)

  Specified by:

  isFactoryForType in interface AdapterFactory

  Overrides:

  isFactoryForType in class AdapterFactoryImpl

• createAdapter

  protected Adapter createAdapter(Notifier target)

  Overrides:

  createAdapter in class AdapterFactoryImpl

• adapt

  public Adapter adapt(Notifier notifier, Object type)

  This implementation substitutes the factory itself as the key for the adapter.

  Specified by:

  adapt in interface AdapterFactory

  Overrides:

  adapt in class AdapterFactoryImpl

• adapt

  public Object adapt(Object object, Object type)

  Specified by:

  adapt in interface AdapterFactory

  Overrides:

  adapt in class AdapterFactoryImpl

• associate

  protected void associate(Adapter adapter, Notifier target)

  This implementation also adds the adapter to the disposable, if it's an IDisposable.

  Overrides:

  associate in class AdapterFactoryImpl

• addListener

  public void addListener(INotifyChangedListener notifyChangedListener)

  This adds a listener.

  Specified by:

  addListener in interface IChangeNotifier

• removeListener

  public void removeListener(INotifyChangedListener notifyChangedListener)

  This removes a listener.

  Specified by:

  removeListener in interface IChangeNotifier

• fireNotifyChanged

  public void fireNotifyChanged(Notification notification)

  This delegates to changeNotifier and to etypesItemProviderAdapterFactory.

  Specified by:

  fireNotifyChanged in interface IChangeNotifier

• dispose

  public void dispose()

  This disposes all of the item providers created by this factory.

  Specified by:

  dispose in interface IDisposable

• getPropertyDescriptors

  public List<IItemPropertyDescriptor> getPropertyDescriptors(EObject eObject, Annotation annotation, ResourceLocator resourceLocator)

  Returns a list of property descriptors for the modeled object representing the given annotation.

  This implementation uses the applicable properties of the modeled object, calling getPropertyDescriptor to create each property descriptor. If that method returns one, it calls createPropertyDescriptorDecorator to decorate it, and then wraps that in a AnnotationItemProviderAdapterFactory.DecategorizingItemPropertyDescritorDecorator. This implementation is likely sufficient for most purposes.

  Parameters:

  eObject - the modeled object.

  annotation - the annotation that it models.

  resourceLocator - the resource locator from which to acquire resources.

• getPropertyDescriptor

  public IItemPropertyDescriptor getPropertyDescriptor(EObject eObject, String key, EStructuralFeature eStructuralFeature, Annotation annotation, ResourceLocator resourceLocator)

  Creates a property descriptor for a property of the modeled object corresponding to the given key and feature for the given annotation.

  This method adapts the object to an IItemPropertySource, fetching the property descriptor from that, if available. This implementation is sufficient if the model is generated or if the ReflectiveItemProviderAdapterFactory is available and provides sufficient support.

  Parameters:

  eObject - the modeled object.

  key - the key of the property.

  eStructuralFeature - the structure feature of the property.

  annotation - the annotation that the modeled object models.

  resourceLocator - the resource locator from which to acquire resources.

  Returns:

  a property descriptor or null.

• createPropertyDescriptorDecorator

  public IItemPropertyDescriptor createPropertyDescriptorDecorator(IItemPropertyDescriptor propertyDescriptor, EObject eObject, String key, EStructuralFeature eStructuralFeature, Annotation annotation, ResourceLocator resourceLocator, EditingDomain domain)

  Creates a property descriptor decorator for the property descriptor of a property of the modeled object corresponding to the given key and feature for the given annotation.

  This implementation creates an instance of AnnotationItemProviderAdapterFactory.ModeledItemPropertyDescriptorDecorator which uses the assistant to convert the model object's value to a literal.

  Parameters:

  propertyDescriptor - the property descriptor to be decorated.

  eObject - the modeled object.

  key - the key of the property.

  eStructuralFeature - the structure feature of the property.

  annotation - the annotation that the modeled object models.

  resourceLocator - the resource locator from which to acquire resources.

  domain - the editing domain to be used to modify the annotation.

  Returns:

  a property descriptor or null.

• getGroupName

  public String getGroupName(EObject instance)

  Returns the group name associated with the given instance object. This will typically be the name of the instances's class. If instances are shown, this name will be shown for the group of properties associated with that instance.

  Parameters:

  instance -

  Returns:

  the group name associated with the given instance object.

  See Also:

  • isShowInstances(Annotation)
  • AnnotationItemProvider.SourcePropertyDescriptor.createPropertyValueWrapper(Object, Object)

• create

  public static AnnotationItemProviderAdapterFactory create(String annotationSoure)

  Creates an annotation item provider adapter factory for the given annotation source.

  Parameters:

  annotationSoure - the annotation source.

  Returns:

  an annotation item provider adapter factory or null if there is no registered factory.