Package net.sourceforge.pmd.util.treeexport

Interface TreeRendererDescriptor

public interface TreeRendererDescriptor
Describes the configuration options of a specific TreeRenderer.
See Also:

  • Method Details

    • newPropertyBundle

      PropertySource newPropertyBundle()
      Returns a new property bundle, that can be used to configure the output of produceRenderer(PropertySource). Properties supported by the renderer are already registered on the returned bundle.

    • id

      String id()
      Returns the ID of this renderer, used to select it. The ID of a descriptor should never change.
      See Also:

    • description

      String description()
      Returns a short description of the format of this renderer's output.

    • produceRenderer

      TreeRenderer produceRenderer(PropertySource properties)
      Builds a new renderer from the given properties.
      Parameters:
      properties - A property bundle, that should have been produced by newPropertyBundle().