com.inline.feature
Interface FeatureActionFactory

All Known Implementing Classes:

AbstractFeatureActionFactory

public interface FeatureActionFactory

FeatureActionFactories produce FeatureActions for individual Features. Factories of all types are registered in the ResourceFactory for the product or a plug-in.

There are three types of actions:

• FeatureActions produced by FeatureActionFactories
• FeatureActions produced by Features directly
• FeatureActions produced by Features' child FeatureSets.
  The overall list of actions produced by Feature.getActions() is a combination of all three.

  FeatureActionFactory produces a set of FeatureActions that are potentially applicable to the feature. Whether or not any particular action is enabled is determined dynamically by the FeatureAction.isEnabled() method. A Feature is likely to build the sets of FeatureActions only once and then cache it.

  See Also:

  FeatureAction, Feature.getActions(), FeatureService.getFeatureActionFactories()

  Field Summary

  static java.lang.String

  TYPE Resource type for instances of FeatureFactory

  Method Summary

  com.sun.java.util.collections.Set	allocateFeatureActions(Feature feature) Returns a set of FeatureActions objects which can operate on the supplied feature.
  com.sun.java.util.collections.Set	getSupportedFeatureTypes(FeatureModel model) A factory is associated with one or more feature types within the scope of every feature model.
  boolean	isEnabled(Feature feature) Should return true if the factory is suited to allocate feature actions for this particular feature.

  Field Detail

  TYPE

  public static final java.lang.String TYPE

  Resource type for instances of FeatureFactory

  Method Detail

  getSupportedFeatureTypes

  public com.sun.java.util.collections.Set getSupportedFeatureTypes(FeatureModel model)

  A factory is associated with one or more feature types within the scope of every feature model. If the factory returns null, it will be allowed to provide actions for all features in the model.

  isEnabled

  public boolean isEnabled(Feature feature)

  Should return true if the factory is suited to allocate feature actions for this particular feature. The type of the feature will be one of the types returned by getSupportedFeatureTypes. The method may return false if there is something on the instance of the feature that would prevent the factory from managing actions. Do not use dynamically changing properties of the feature to perform this test. That logic belongs in the FeatureActions.isEnabled() method.

  allocateFeatureActions

  public com.sun.java.util.collections.Set allocateFeatureActions(Feature feature)

  Returns a set of FeatureActions objects which can operate on the supplied feature. Note that the overall list of actions is composed of sets returned by all relevant factories.