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