View Javadoc
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.commons.csv.CSVFormat;
22  import org.apache.commons.csv.QuoteMode;
23  
24  /**
25   * A superclass for Comma-Separated Value (CSV) layouts.
26   * 
27   * Depends on Apache Commons CSV 1.2.
28   * 
29   * @since 2.4
30   */
31  public abstract class AbstractCsvLayout extends AbstractStringLayout {
32  
33      protected static final String DEFAULT_CHARSET = "UTF-8";
34      protected static final String DEFAULT_FORMAT = "Default";
35      private static final String CONTENT_TYPE = "text/csv";
36      private static final long serialVersionUID = 1L;
37  
38      private final CSVFormat format;
39  
40      protected AbstractCsvLayout(final Charset charset, final CSVFormat csvFormat, final String header,
41              final String footer) {
42          super(charset, toBytes(header, charset), toBytes(footer, charset));
43          this.format = csvFormat;
44      }
45  
46      protected static CSVFormat createFormat(final String format, final Character delimiter, final Character escape,
47              final Character quote, final QuoteMode quoteMode, final String nullString, final String recordSeparator) {
48          CSVFormat csvFormat = CSVFormat.valueOf(format);
49          if (delimiter != null) {
50              csvFormat = csvFormat.withDelimiter(delimiter);
51          }
52          if (escape != null) {
53              csvFormat = csvFormat.withEscape(escape);
54          }
55          if (quote != null) {
56              csvFormat = csvFormat.withQuote(quote);
57          }
58          if (quoteMode != null) {
59              csvFormat = csvFormat.withQuoteMode(quoteMode);
60          }
61          if (nullString != null) {
62              csvFormat = csvFormat.withNullString(nullString);
63          }
64          if (recordSeparator != null) {
65              csvFormat = csvFormat.withRecordSeparator(recordSeparator);
66          }
67          return csvFormat;
68      }
69  
70      @Override
71      public String getContentType() {
72          return CONTENT_TYPE + "; charset=" + this.getCharset();
73      }
74  
75      public CSVFormat getFormat() {
76          return format;
77      }
78  }