    001    /*
    002     * Licensed to the Apache Software Foundation (ASF) under one or more
    003     * contributor license agreements. See the NOTICE file distributed with
    004     * this work for additional information regarding copyright ownership.
    005     * The ASF licenses this file to You under the Apache license, Version 2.0
    006     * (the "License"); you may not use this file except in compliance with
    007     * the License. You may obtain a copy of the License at
    008     *
    009     *      http://www.apache.org/licenses/LICENSE-2.0
    010     *
    011     * Unless required by applicable law or agreed to in writing, software
    012     * distributed under the License is distributed on an "AS IS" BASIS,
    013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014     * See the license for the specific language governing permissions and
    015     * limitations under the license.
    016     */
    017    package org.apache.logging.log4j.util;
    018
    019    import java.util.Map.Entry;
    020
    021    /**
    022     * <em>Consider this class private.</em>
    023     */
    024    public class StringBuilders {
    025
    026        /**
    027         * Appends in the following format: double quoted value.
    028         *
    029         * @param sb
    030         *        a string builder
    031         * @param value
    032         *        a value
    033         * @return {@code "value"}
    034         */
    035        public static StringBuilder appendDqValue(StringBuilder sb, Object value) {
    036            return sb.append(Chars.DQUOTE).append(value).append(Chars.DQUOTE);
    037        }
    038
    039        /**
    040         * Appends in the following format: key=double quoted value.
    041         *
    042         * @param sb
    043         *        a string builder
    044         * @param entry
    045         *        a map entry
    046         * @return {@code key="value"}
    047         */
    048        public static StringBuilder appendKeyDqValue(StringBuilder sb, Entry<String, String> entry) {
    049            return appendKeyDqValue(sb, entry.getKey(), entry.getValue());
    050        }
    051
    052        /**
    053         * Appends in the following format: key=double quoted value.
    054         *
    055         * @param sb
    056         *        a string builder
    057         * @param key
    058         *        a key
    059         * @param value
    060         *        a value
    061         * @return {@code key="value"}
    062         */
    063        public static StringBuilder appendKeyDqValue(StringBuilder sb, String key, Object value) {
    064            return sb.append(key).append(Chars.EQ).append(Chars.DQUOTE).append(value).append(Chars.DQUOTE);
    065        }
    066
    067    }