org.eclipse.xtext.ui.shared.contribution

Interface ISharedStateContributionRegistry

All Known Implementing Classes:

SharedStateContributionRegistryImpl

@Beta
public interface ISharedStateContributionRegistry

A registry for shared contributions. Each contribution is loaded only once. That is, it is effectively a singleton.

The contributions are registered by the extension point org.eclipse.xtext.ui.shared.sharedStateContributingModule.

See SharedStateContribution for a list of contribution types that are used by the framework.

Since:

2.5

Author:

Sebastian Zarnekow - Initial contribution and API

Method Summary

Methods

Modifier and Type	Method and Description
<T> com.google.common.collect.ImmutableList<? extends T>	getContributedInstances(java.lang.Class<T> type) Initialize and return all known contributions.
com.google.common.collect.ImmutableList<? extends SharedStateContribution>	getContributions() Returns all contribution handles.
<T> com.google.common.collect.ImmutableList<? extends com.google.inject.Provider<? extends T>>	getLazyContributedInstances(java.lang.Class<T> type) Returns providers for all known contribution for the given type.
<T> com.google.inject.Provider<? extends T>	getLazySingleContributedInstance(java.lang.Class<T> type) Return a provider the single known contribution for the given type.
<T> T	getSingleContributedInstance(java.lang.Class<T> type) Initialize and return the single known contribution for the given type.

Method Detail

getContributions

com.google.common.collect.ImmutableList<? extends SharedStateContribution> getContributions()

Returns all contribution handles. The result is never null but possibly empty.

getContributedInstances

<T> com.google.common.collect.ImmutableList<? extends T> getContributedInstances(java.lang.Class<T> type)

Initialize and return all known contributions. The result is never null but possibly empty.

getSingleContributedInstance

<T> T getSingleContributedInstance(java.lang.Class<T> type)
                               throws java.lang.IllegalStateException

Initialize and return the single known contribution for the given type. Throws an IllegalStateException if there is no such contribution or more than one contribution for that type.

Throws:

java.lang.IllegalStateException

getLazyContributedInstances

<T> com.google.common.collect.ImmutableList<? extends com.google.inject.Provider<? extends T>> getLazyContributedInstances(java.lang.Class<T> type)

Returns providers for all known contribution for the given type. The result is never null but possibly empty.

getLazySingleContributedInstance

<T> com.google.inject.Provider<? extends T> getLazySingleContributedInstance(java.lang.Class<T> type)
                                                                         throws java.lang.IllegalStateException

Return a provider the single known contribution for the given type. Throws an IllegalStateException if there is no such contribution or more than one contribution for that type.

Throws:

java.lang.IllegalStateException