KeyTranslator.java

/**
 * Copyright (c) 2008--2015 Red Hat, Inc.
 *
 * This software is licensed to you under the GNU General Public License,
 * version 2 (GPLv2). There is NO WARRANTY for this software, express or
 * implied, including the implied warranties of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. You should have received a copy of GPLv2
 * along with this software; if not, see
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
 *
 * Red Hat trademarks are not licensed under GPLv2. No permission is
 * granted to use or replicate Red Hat trademarks that are incorporated
 * in this software or its documentation.
 */
package com.redhat.satellite.search.config;


/**
 * Translator
 * @version $Rev$
 */
public interface KeyTranslator {

    /**
     * Translates the given key into something else. That something else is
     * determined by the specific implementation. The value for the given key
     * should not be affected.
     * @param key key to be translated.
     * @return The translated key.
     */
    String translateKey(String key);

    /**
     * Returns true if the key should be translated.
     * @param key to be translated
     * @return true if the key should be translated.
     */
    boolean shouldTranslate(String key);
}