001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
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,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.core;
018
019import java.nio.charset.Charset;
020
021/**
022 * Instantiates the @{link Layout} type for String-based layouts.
023 */
024public interface StringLayout extends Layout<String> {
025
026    /**
027     * Gets the Charset this layout uses to encode Strings into bytes.
028     *
029     * @return the Charset this layout uses to encode Strings into bytes.
030     */
031    Charset getCharset();
032
033}