liquibase.configuration.ConfiguredValueModifier Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of liquibase-core Show documentation

Liquibase is a tool for managing and executing database changes.

There is a newer version: 4.30.0

package liquibase.configuration;

import liquibase.plugin.Plugin;

/**
 * Provides a way for {@link LiquibaseConfiguration} to modify configured values.
 * After all the {@link ConfigurationValueProvider}s have been checked for a value, all registered {@link ConfiguredValueModifier}s are called in {@link #getOrder()} order.
 */
public interface ConfiguredValueModifier extends Plugin {

    /**
     * Returns the order in which modifiers should be run. Modifiers with a higher order will run after modifiers with a lower order value.
     *
     * @return int
     */
    int getOrder();

    /**
     * Called to potentially override the given {@link ConfiguredValue}.
     * Implementations can use any information from the passed {@link ConfiguredValue}, including calling getProvidedValue() to determine keys used, format of the value, etc.
     * If an implementation wants to modify the value, it should call {@link ConfiguredValue#override(ProvidedValue)}
     */
    void override(ConfiguredValue object);
}