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 final class StringBuilders {
25      private StringBuilders() {
26      }
27  
28      /**
29       * Appends in the following format: double quoted value.
30       * 
31       * @param sb a string builder
32       * @param value a value
33       * @return {@code "value"}
34       */
35      public static StringBuilder appendDqValue(final StringBuilder sb, final 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 a string builder
43       * @param entry a map entry
44       * @return {@code key="value"}
45       */
46      public static StringBuilder appendKeyDqValue(final StringBuilder sb, final Entry<String, String> entry) {
47          return appendKeyDqValue(sb, entry.getKey(), entry.getValue());
48      }
49  
50      /**
51       * Appends in the following format: key=double quoted value.
52       * 
53       * @param sb a string builder
54       * @param key a key
55       * @param value a value
56       * @return the specified StringBuilder
57       */
58      public static StringBuilder appendKeyDqValue(final StringBuilder sb, final String key, final Object value) {
59          return sb.append(key).append(Chars.EQ).append(Chars.DQUOTE).append(value).append(Chars.DQUOTE);
60      }
61  
62  }