org.apache.gobblin.util.deprecation

Class DeprecationUtils

java.lang.Object

org.apache.gobblin.util.deprecation.DeprecationUtils

public class DeprecationUtils
extends Object

Utilities to handle deprecations in Gobblin.

Constructor Summary

Constructors

Constructor and Description
DeprecationUtils()

Method Summary

Modifier and Type	Method and Description
static void	renameDeprecatedKeys(State state, String currentKey, List<String> deprecatedKeys) Sets an option in a State to the first available value of a list of deprecatedKeys.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeprecationUtils

public DeprecationUtils()

Method Detail

renameDeprecatedKeys

public static void renameDeprecatedKeys(State state,
                                        String currentKey,
                                        List<String> deprecatedKeys)

Sets an option in a State to the first available value of a list of deprecatedKeys. For example, if an option "optiona" was previously called "optionb" or "optionc", calling renameDeprecatedKeys(State, String, List) will search for the first available key-value pair with key optiona, optionb, or optionc, and set optiona to that value.

Parameters:

state - State to modify.

currentKey - current name of an option.

deprecatedKeys - all other names that States could use to refer to that option.