org.opencms.util.I_CmsMacroResolver Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opencms-test Show documentation

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 18.0

Show newest version

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software GmbH & Co. KG, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.util;

/**
 * Describes a macro mapper, which is used to efficiently resolve macros
 * in the form of %(key) or ${key} in an input String.
 *
 * Starting with OpenCms 7.0, the preferred form of a macro is %(key). This is to
 * avoid conflicts / confusion with the JSP EL, which also uses the ${key} syntax.

 *
 * The macro replacement is pre-implemented in
 * {@link org.opencms.util.CmsMacroResolver#resolveMacros(String, I_CmsMacroResolver)}.

 *
 * @since 6.0.0
 */
public interface I_CmsMacroResolver {

    /** Delimiter char '%' for a macro - new / current style. */
    char MACRO_DELIMITER = '%';

    /** Delimiter char '$' for a macro - old style. */
    char MACRO_DELIMITER_OLD = '$';

    /** End char ')' for a macro - new / current style. */
    char MACRO_END = ')';

    /** End char '}' for a macro - old style. */
    char MACRO_END_OLD = '}';

    /** Start char '(' for a macro - new / current style. */
    char MACRO_START = '(';

    /** Start char '{' for a macro - old style.  */
    char MACRO_START_OLD = '{';

    /**
     * Resolves a single macro to the macro value, returns null if the macro could not be resolved.

     *
     * @param macro the macro to resolve
     * @return the resolved macro or null if the macro could not be resolved
     */
    String getMacroValue(String macro);

    /**
     * Returns true if macros that could not be resolved are kept "as is" in the
     * input String, false if they are replaced by an empty String.

     *
     * @return true if macros that could not be resolved are kept "as is" in the
     *      input String, false if they are replaced by an empty String
     */
    boolean isKeepEmptyMacros();

    /**
     * Resolves all macros in the input, replacing them with the macro values.
     *
     * The flag {@link #isKeepEmptyMacros()} controls how to deal with
     * macros found in the input that can not be resolved.
     *
     * @param input the input to resolve the macros in
     *
     * @return the input with all macros resolved
     */
    String resolveMacros(String input);
}