Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.2 / log4j-core / xref / org / apache / logging / log4j / core / layout / AbstractCsvLayout.html
blob: 74a2557cd9376c1b1840911b0314d2818bcff36a [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>AbstractCsvLayout xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/logging/log4j/core/layout/AbstractCsvLayout.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache license, Version 2.0</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * See the license for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * limitations under the license.</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">package</strong> org.apache.logging.log4j.core.layout;
<a class="jxr_linenumber" name="L18" href="#L18">18</a>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">import</strong> java.nio.charset.Charset;
<a class="jxr_linenumber" name="L20" href="#L20">20</a>
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> org.apache.commons.csv.CSVFormat;
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.commons.csv.QuoteMode;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.core.config.Configuration;
<a class="jxr_linenumber" name="L24" href="#L24">24</a>
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * A superclass for Comma-Separated Value (CSV) layouts.</em>
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * Depends on Apache Commons CSV 1.2.</em>
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * @since 2.4</em>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractCsvLayout.html">AbstractCsvLayout</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractStringLayout.html">AbstractStringLayout</a> {
<a class="jxr_linenumber" name="L33" href="#L33">33</a>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_CHARSET = <span class="jxr_string">"UTF-8"</span>;
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_FORMAT = <span class="jxr_string">"Default"</span>;
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String CONTENT_TYPE = <span class="jxr_string">"text/csv"</span>;
<a class="jxr_linenumber" name="L37" href="#L37">37</a>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> CSVFormat createFormat(<strong class="jxr_keyword">final</strong> String format, <strong class="jxr_keyword">final</strong> Character delimiter, <strong class="jxr_keyword">final</strong> Character escape,
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">final</strong> Character quote, <strong class="jxr_keyword">final</strong> QuoteMode quoteMode, <strong class="jxr_keyword">final</strong> String nullString, <strong class="jxr_keyword">final</strong> String recordSeparator) {
<a class="jxr_linenumber" name="L40" href="#L40">40</a> CSVFormat csvFormat = CSVFormat.valueOf(format);
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">if</strong> (isNotNul(delimiter)) {
<a class="jxr_linenumber" name="L42" href="#L42">42</a> csvFormat = csvFormat.withDelimiter(delimiter);
<a class="jxr_linenumber" name="L43" href="#L43">43</a> }
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">if</strong> (isNotNul(escape)) {
<a class="jxr_linenumber" name="L45" href="#L45">45</a> csvFormat = csvFormat.withEscape(escape);
<a class="jxr_linenumber" name="L46" href="#L46">46</a> }
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">if</strong> (isNotNul(quote)) {
<a class="jxr_linenumber" name="L48" href="#L48">48</a> csvFormat = csvFormat.withQuote(quote);
<a class="jxr_linenumber" name="L49" href="#L49">49</a> }
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">if</strong> (quoteMode != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L51" href="#L51">51</a> csvFormat = csvFormat.withQuoteMode(quoteMode);
<a class="jxr_linenumber" name="L52" href="#L52">52</a> }
<a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">if</strong> (nullString != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L54" href="#L54">54</a> csvFormat = csvFormat.withNullString(nullString);
<a class="jxr_linenumber" name="L55" href="#L55">55</a> }
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">if</strong> (recordSeparator != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L57" href="#L57">57</a> csvFormat = csvFormat.withRecordSeparator(recordSeparator);
<a class="jxr_linenumber" name="L58" href="#L58">58</a> }
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">return</strong> csvFormat;
<a class="jxr_linenumber" name="L60" href="#L60">60</a> }
<a class="jxr_linenumber" name="L61" href="#L61">61</a>
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isNotNul(<strong class="jxr_keyword">final</strong> Character character) {
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">return</strong> character != <strong class="jxr_keyword">null</strong> &amp;&amp; character.charValue() != 0;
<a class="jxr_linenumber" name="L64" href="#L64">64</a> }
<a class="jxr_linenumber" name="L65" href="#L65">65</a>
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> CSVFormat format;
<a class="jxr_linenumber" name="L67" href="#L67">67</a>
<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">protected</strong> <a href="../../../../../../org/apache/logging/log4j/core/layout/AbstractCsvLayout.html">AbstractCsvLayout</a>(<strong class="jxr_keyword">final</strong> <a href="../../../../../../org/apache/logging/log4j/core/config/Configuration.html">Configuration</a> config, <strong class="jxr_keyword">final</strong> Charset charset, <strong class="jxr_keyword">final</strong> CSVFormat csvFormat,
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">final</strong> String header, <strong class="jxr_keyword">final</strong> String footer) {
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">super</strong>(config, charset,
<a class="jxr_linenumber" name="L71" href="#L71">71</a> PatternLayout.newSerializerBuilder().setConfiguration(config).setPattern(header).build(),
<a class="jxr_linenumber" name="L72" href="#L72">72</a> PatternLayout.newSerializerBuilder().setConfiguration(config).setPattern(footer).build());
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">this</strong>.format = csvFormat;
<a class="jxr_linenumber" name="L74" href="#L74">74</a> }
<a class="jxr_linenumber" name="L75" href="#L75">75</a>
<a class="jxr_linenumber" name="L76" href="#L76">76</a> @Override
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">public</strong> String getContentType() {
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">return</strong> CONTENT_TYPE + <span class="jxr_string">"; charset="</span> + <strong class="jxr_keyword">this</strong>.getCharset();
<a class="jxr_linenumber" name="L79" href="#L79">79</a> }
<a class="jxr_linenumber" name="L80" href="#L80">80</a>
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">public</strong> CSVFormat getFormat() {
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">return</strong> format;
<a class="jxr_linenumber" name="L83" href="#L83">83</a> }
<a class="jxr_linenumber" name="L84" href="#L84">84</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 1999&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>