TransformerMode.java

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2016 Lachlan Dowding
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package permafrost.tundra.data.transform;

/**
 * The different modes of element transformations available.
 */
public enum TransformerMode {
    KEYS, VALUES, KEYS_AND_VALUES;

    /**
     * The default transformer mode, if none is specified.
     */
    public static final TransformerMode DEFAULT_TRANSFORMER_MODE = VALUES;

    /**
     * Returns a TransformerMode for the given string value.
     *
     * @param value The value to be converted to a Mode.
     * @return      The TransformerMode representing the given value.
     */
    public static TransformerMode normalize(String value) {
        return normalize(value == null ? null : valueOf(value.trim().replace(' ', '_').toUpperCase()));
    }

    /**
     * Normalizes a TransformerMode.
     *
     * @param mode  The TransformerMode to be normalized.
     * @return      If the given mode is null the default mode is returned, otherwise the given mode.
     */
    public static TransformerMode normalize(TransformerMode mode) {
        return mode == null ? DEFAULT_TRANSFORMER_MODE : mode;
    }
}