Class RenderConfig
java.lang.Object
ac.simons.neo4j.migrations.core.catalog.RenderConfig
Contextual information passed to renderers.
- Since:
- 1.7.0
- Author:
- Michael J. Simons
- Soundtrack
- Anthrax - Spreading The Disease
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Deprecated.Not meant to be part of a public API, but cannot restrict it in Java 8static interface
Defines the version and the edition of the current context.static interface
Additional options passed to a Cypher renderer.static interface
Allows adding idempotency to the context.static interface
Allows adding idempotency to the context.static interface
Additional options passed to an XML renderer. -
Method Summary
Modifier and TypeMethodDescriptioncreate()
Starts building a render context that eventually will result in a CREATE ... statement.drop()
Starts building a render context that eventually will result in a DROP ... statement.This is useful to get a render context that ignores the name of an object to force dropping things created without a name.withAdditionalOptions
(List<? extends RenderConfig.AdditionalRenderingOptions> newOptions) Adds additional options to the renderer or deletes the existing ones.
-
Method Details
-
create
Starts building a render context that eventually will result in a CREATE ... statement.- Returns:
- An ongoing build step
-
drop
Starts building a render context that eventually will result in a DROP ... statement.- Returns:
- An ongoing build step
-
ignoreName
This is useful to get a render context that ignores the name of an object to force dropping things created without a name.- Returns:
- a new context ignoring the name
-
withAdditionalOptions
public RenderConfig withAdditionalOptions(List<? extends RenderConfig.AdditionalRenderingOptions> newOptions) Adds additional options to the renderer or deletes the existing ones.- Parameters:
newOptions
- New list of options, may be null or empty- Returns:
- A (potentially) new
RenderConfig
- Since:
- 1.11.0
-