Module org.neo4j.cypherdsl.core
Package org.neo4j.cypherdsl.core.renderer

Interface Renderer

All Known Subinterfaces:
GeneralizedRenderer
@API(status=STABLE, since="1.0") public sealed interface Renderer permits GeneralizedRenderer (not exhaustive)
Instances of this class are supposed to be thread-safe. Please use getDefaultRenderer() to get hold of an implementation.
Since:
1.0
Author:
Michael J. Simons

  • Method Details

    • getDefaultRenderer

      static Renderer getDefaultRenderer()
      Provides the default renderer. This method may or may not provide shared instances of the renderer.
      Returns:
      the default renderer.

    • getRenderer

      static Renderer getRenderer(Configuration configuration)
      Creates a new renderer for the given configuration.
      Parameters:
      configuration - the configuration for this renderer
      Returns:
      a new renderer (might be a shared instance).

    • getRenderer

      static <T extends Renderer> T getRenderer(Configuration configuration, Class<T> type)
      Creates a new renderer for the given configuration.
      Type Parameters:
      T - the specific type of the renderer
      Parameters:
      configuration - the configuration for this renderer
      type - reification of the renderers type
      Returns:
      a new renderer (might be a shared instance).
      Since:
      2023.1.0

    • render

      String render(Statement statement)
      Renders a statement.
      Parameters:
      statement - the statement to render
      Returns:
      the rendered Cypher statement.