001/*
002 * Copyright 2023 the original author or authors.
003 * <p>
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 * <p>
008 * https://www.apache.org/licenses/LICENSE-2.0
009 * <p>
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package de.cuioss.tools.formatting.template.token;
017
018import java.io.Serializable;
019
020import de.cuioss.tools.formatting.template.FormatterSupport;
021
022/**
023 * Any token should provide a method to substitute "placeholder" with his value
024 *
025 * @author Eugen Fischer
026 */
027public interface Token extends Serializable {
028
029    /**
030     * @param content must not be null
031     * @return token specific template with substituted attribute value if attribute
032     *         exists, <code>empty</code> String otherwise
033     */
034    String substituteAttribute(FormatterSupport content);
035
036    /**
037     * @return true if Token has no substitutions
038     */
039    boolean isStringToken();
040
041}