Interface ChangePluginDefinedInfoFactory


public interface ChangePluginDefinedInfoFactory
Interface for plugins to provide additional fields in ChangeInfo.

Register a ChangePluginDefinedInfoFactory in a plugin Module like this:

 DynamicSet.bind(binder(), ChangePluginDefinedInfoFactory.class).to(YourClass.class);
 

See the plugin developer documentation for more details and examples.

  • Method Details

    • createPluginDefinedInfos

      Map<Change.Id,PluginDefinedInfo> createPluginDefinedInfos(Collection<ChangeData> cds, DynamicOptions.BeanProvider beanProvider, String plugin)
      Create a plugin-provided info field for each of the provided ChangeDatas.

      Typically, implementations will subclass PluginDefinedInfo to add additional fields.

      Parameters:
      cds - changes.
      beanProvider - provider of DynamicBeans, which may be used for reading options.
      plugin - plugin name.
      Returns:
      map of the plugin's special info for each change