Package ac.simons.neo4j.migrations.core.catalog

Class RenderConfig

java.lang.Object

ac.simons.neo4j.migrations.core.catalog.RenderConfig

public final class RenderConfig
extends Object

Contextual information passed to renderers.

Since:

1.7.0

Author:

Michael J. Simons

Soundtrack

Anthrax - Spreading The Disease

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RenderConfig.AdditionalRenderingOptions	Deprecated. Not meant to be part of a public API, but cannot restrict it in Java 8
static interface	RenderConfig.Builder	Defines the version and the edition of the current context.
static interface	RenderConfig.CypherRenderingOptions	Additional options passed to a Cypher renderer.
static interface	RenderConfig.IfExistsConfigBuilder	Allows adding idempotency to the context.
static interface	RenderConfig.IfNotExistsConfigBuilder	Allows adding idempotency to the context.
static interface	RenderConfig.XMLRenderingOptions	Additional options passed to an XML renderer.

Method Summary

Modifier and Type	Method	Description
static RenderConfig.IfNotExistsConfigBuilder	create()	Starts building a render context that eventually will result in a CREATE ... statement.
static RenderConfig.IfExistsConfigBuilder	drop()	Starts building a render context that eventually will result in a DROP ... statement.
RenderConfig	ignoreName()	This is useful to get a render context that ignores the name of an object to force dropping things created without a name.
RenderConfig	withAdditionalOptions(List<? extends RenderConfig.AdditionalRenderingOptions> newOptions)	Adds additional options to the renderer or deletes the existing ones.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

public static RenderConfig.IfNotExistsConfigBuilder create()

Starts building a render context that eventually will result in a CREATE ... statement.

Returns:

An ongoing build step

drop

public static RenderConfig.IfExistsConfigBuilder drop()

Starts building a render context that eventually will result in a DROP ... statement.

Returns:

An ongoing build step

ignoreName

public RenderConfig 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