Class JenkinsWidgetFactory

  • All Implemented Interfaces:

    public final class JenkinsWidgetFactory
    extends WidgetFactory<View,​Widget>
    New widgets should provide a WidgetFactory instead of relying on this legacy lookup.
    Add widgets annotated with @Extension, or added manually to Jenkins via Jenkins.get().getWidgets().add(...)
    • Constructor Detail

      • JenkinsWidgetFactory

        public JenkinsWidgetFactory()
    • Method Detail

      • widgetType

        public Class<Widget> widgetType()
        Description copied from class: WidgetFactory
        A supertype of any widgets this factory might produce. Defined so that factories which produce irrelevant widgets need not be consulted. If your implementation was returning multiple disparate kinds of widgets, it is best to split it into two factories.

        If an API defines an abstract Widget subtype, and you are providing a concrete implementation, you may return the API type here to delay class loading.

        Specified by:
        widgetType in class WidgetFactory<View,​Widget>
        a bound for the result of WidgetFactory.createFor(T)
      • createFor

        public Collection<Widget> createFor​(@NonNull
                                            View target)
        Description copied from class: WidgetFactory
        Creates widgets for a given object. This may be called frequently for the same object, so if your implementation is expensive, do your own caching.
        Specified by:
        createFor in class WidgetFactory<View,​Widget>
        target - a widgetable object
        a possible empty set of widgets (typically either using Set.of()).