com.aspectran.freemarker.directive.TrimDirective Maven / Gradle / Ivy

Go to download

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

Add-on package for using Freemarker as the templating engine

The newest version!

/*
 * Copyright (c) 2008-2024 The Aspectran Project
 *
 * Licensed 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 com.aspectran.freemarker.directive;

/**
 * The Class TrimDirective.
 *
 * 
 * Basically, this trims the body string(removing leading and tailing spaces).
 * 
If the result of trimming is empty, it will return just empty string.
 * 
prefix="string" 
If the result of trimming is not empty, prefix "string" to the result.
 * 
suffix="string" 
If the result of trim is not empty, suffix "string" to the result.
 * 
deprefixes=["string1", "string2", ...] 
If the result of trimming is not empty,
 * the first appearing string in the leading of the result will be removed.
 * 
desuffixes=["string1", "string2", ...] 
If the result of trimming is not empty,
 * the first appearing string in the tail of the result will be removed.
 * 
caseSensitive="true" or "false" 
true to case sensitive; false to ignore case sensitive.
 * 
 *
 * Created: 2016. 1. 29.
 */
public interface TrimDirective {

    String PREFIX_PARAM_NAME = "prefix";

    String SUFFIX_PARAM_NAME = "suffix";

    String DEPREFIXES_PARAM_NAME = "deprefixes";

    String DESUFFIXES_PARAM_NAME = "desuffixes";

    String CASE_SENSITIVE_PARAM_NAME = "caseSensitive";

    /**
     * Gets group name.
     * @return the group name
     */
    String getGroupName();

    /**
     * Gets directive name.
     * @return the directive name
     */
    String getDirectiveName();

}