1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache license, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the license for the specific language governing permissions and
15 * limitations under the license.
16 */
17 package org.apache.logging.log4j.core.layout;
18
19 import java.nio.charset.Charset;
20
21 import org.apache.logging.log4j.core.LogEvent;
22
23 /**
24 * Abstract base class for Layouts that result in a String.
25 */
26 public abstract class AbstractStringLayout extends AbstractLayout<String> {
27
28 /**
29 * The charset of the formatted message.
30 */
31 private final Charset charset;
32
33 protected AbstractStringLayout(final Charset charset) {
34 this.charset = charset;
35 }
36
37 /**
38 * Formats the Log Event as a byte array.
39 *
40 * @param event The Log Event.
41 * @return The formatted event as a byte array.
42 */
43 @Override
44 public byte[] toByteArray(final LogEvent event) {
45 return toSerializable(event).getBytes(charset);
46 }
47
48 /**
49 * @return The default content type for Strings.
50 */
51 @Override
52 public String getContentType() {
53 return "text/plain";
54 }
55
56 protected Charset getCharset() {
57 return charset;
58 }
59 }