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     */
017    package org.apache.logging.log4j.core.layout;
018    
019    import java.nio.charset.Charset;
020    
021    import org.apache.logging.log4j.core.LogEvent;
022    import org.apache.logging.log4j.core.util.Charsets;
023    
024    /**
025     * Abstract base class for Layouts that result in a String.
026     */
027    public abstract class AbstractStringLayout extends AbstractLayout<String> {
028    
029        /**
030         * The charset for the formatted message.
031         */
032        private final Charset charset;
033    
034        protected AbstractStringLayout(final Charset charset) {
035            this.charset = charset == null ? Charsets.UTF_8 : charset;
036        }
037    
038        /**
039         * Formats the Log Event as a byte array.
040         *
041         * @param event The Log Event.
042         * @return The formatted event as a byte array.
043         */
044        @Override
045        public byte[] toByteArray(final LogEvent event) {
046            return toSerializable(event).getBytes(charset);
047        }
048    
049        /**
050         * @return The default content type for Strings.
051         */
052        @Override
053        public String getContentType() {
054            return "text/plain";
055        }
056    
057        protected Charset getCharset() {
058            return charset;
059        }
060    }