001/*
002 * ============================================================================
003 *  Copyright © 2002-2021 by Thomas Thrien.
004 *  All Rights Reserved.
005 * ============================================================================
006 *  Licensed to the public under the agreements of the GNU Lesser General Public
007 *  License, version 3.0 (the "License"). You may obtain a copy of the License at
008 *
009 *       http://www.gnu.org/licenses/lgpl.html
010 *
011 *  Unless required by applicable law or agreed to in writing, software
012 *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
013 *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
014 *  License for the specific language governing permissions and limitations
015 *  under the License.
016 */
017
018package org.tquadrat.foundation.javacomposer.internal;
019
020import static org.apiguardian.api.API.Status.INTERNAL;
021
022import org.apiguardian.api.API;
023import org.tquadrat.foundation.annotation.ClassVersion;
024
025/**
026 *  This is the definition for
027 *  {@link org.tquadrat.foundation.javacomposer.Layout}.
028 *  It provides the base implementations for the various layout emit methods.
029 *
030 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
031 *  @version $Id: LayoutWriter.java 920 2021-05-23 14:27:24Z tquadrat $
032 *
033 *  @UMLGraph.link
034 *  @since 0.2.0
035 */
036@ClassVersion( sourceVersion = "$Id: LayoutWriter.java 920 2021-05-23 14:27:24Z tquadrat $" )
037@API( status = INTERNAL, since = "0.2.0" )
038public interface LayoutWriter
039{
040        /*---------*\
041    ====** Methods **==========================================================
042        \*---------*/
043    /**
044     * Returns the indentation String for this layout.
045     *
046     * @return The indentation.
047     */
048    public String indent();
049
050    /**
051     *  Returns the tabulator size this layout was configured with.
052     *
053     * @return  The tabulator size.
054     */
055    public int tabsize();
056}
057//  interface LayoutWriter
058
059/*
060 *  End of File
061 */