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.util;
18  
19  import java.util.Map.Entry;
20  
21  /**
22   * <em>Consider this class private.</em>
23   */
24  public class StringBuilders {
25  
26      /**
27       * Appends in the following format: double quoted value.
28       * 
29       * @param sb
30       *        a string builder
31       * @param value
32       *        a value
33       * @return {@code "value"}
34       */
35      public static StringBuilder appendDqValue(StringBuilder sb, Object value) {
36          return sb.append(Chars.DQUOTE).append(value).append(Chars.DQUOTE);
37      }
38  
39      /**
40       * Appends in the following format: key=double quoted value.
41       * 
42       * @param sb
43       *        a string builder
44       * @param entry
45       *        a map entry
46       * @return {@code key="value"}
47       */
48      public static StringBuilder appendKeyDqValue(StringBuilder sb, Entry<String, String> entry) {
49          return appendKeyDqValue(sb, entry.getKey(), entry.getValue());
50      }
51  
52      /**
53       * Appends in the following format: key=double quoted value.
54       * 
55       * @param sb
56       *        a string builder
57       * @param key
58       *        a key
59       * @param value
60       *        a value
61       * @return {@code key="value"}
62       */
63      public static StringBuilder appendKeyDqValue(StringBuilder sb, String key, Object value) {
64          return sb.append(key).append(Chars.EQ).append(Chars.DQUOTE).append(value).append(Chars.DQUOTE);
65      }
66  
67  }