001/*
002 * Configurate
003 * Copyright (C) zml and Configurate contributors
004 *
005 * Licensed under the Apache License, Version 2.0 (the "License");
006 * you may not use this file except in compliance with the License.
007 * You may obtain a copy of the License at
008 *
009 *    http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.spongepowered.configurate.util;
018
019/**
020 * An enforced style of naming.
021 *
022 * <p>Common formats are exposed in {@link NamingSchemes}</p>
023 *
024 * @since 4.0.0
025 */
026@FunctionalInterface
027public interface NamingScheme {
028
029    /**
030     * Given an input string of unknown formatting, make it follow a
031     * naming scheme.
032     *
033     * @param input input string
034     * @return output string
035     * @since 4.0.0
036     */
037    String coerce(String input);
038
039}