freemarker.core.ParserConfiguration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of freemarker-gae Show documentation

Google App Engine compliant variation of FreeMarker. FreeMarker is a "template engine"; a generic tool to generate text output based on templates.

There is a newer version: 2.3.33

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package freemarker.core;

import freemarker.template.Configuration;
import freemarker.template.Version;

/**
 * Don't implement this interface yourself; use the existing implementation(s). This interface is implemented by
 * classes that hold settings that affect parsing. New parser settings can be added in new FreeMarker versions, which
 * will break your implementation.
 * 
 * @since 2.3.24
 */
public interface ParserConfiguration {

    /**
     * See {@link Configuration#getTagSyntax()}.
     */
    int getTagSyntax();

    /**
     * See {@link Configuration#getInterpolationSyntax()}.
     *
     * @since 2.3.28
     */
    int getInterpolationSyntax();
    
    /**
     * See {@link Configuration#getNamingConvention()}.
     */
    int getNamingConvention();

    /**
     * See {@link Configuration#getWhitespaceStripping()}.
     */
    boolean getWhitespaceStripping();

    /**
     * Overlaps with {@link Configurable#getArithmeticEngine()}; the parser needs this for creating numerical literals.
     */
    ArithmeticEngine getArithmeticEngine();
    
    /**
     * See {@link Configuration#getStrictSyntaxMode()}.
     */
    boolean getStrictSyntaxMode();
    
    /**
     * See {@link Configuration#getAutoEscapingPolicy()}.
     */
    int getAutoEscapingPolicy();
    
    /**
     * See {@link Configuration#getOutputEncoding()}.
     */
    OutputFormat getOutputFormat();
    
    /**
     * See {@link Configuration#getRecognizeStandardFileExtensions()}.
     */
    boolean getRecognizeStandardFileExtensions();
    
    /**
     * See {@link Configuration#getIncompatibleImprovements()}.
     */
    Version getIncompatibleImprovements();
    
    /**
     * See {@link Configuration#getTabSize()}.
     * 
     * @since 2.3.25
     */
    int getTabSize();

}