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 */
017package org.apache.logging.log4j.util;
018
019import java.util.Map.Entry;
020
021/**
022 * <em>Consider this class private.</em>
023 */
024public final class StringBuilders {
025    private StringBuilders() {
026    }
027
028    /**
029     * Appends in the following format: double quoted value.
030     * 
031     * @param sb a string builder
032     * @param value a value
033     * @return {@code "value"}
034     */
035    public static StringBuilder appendDqValue(final StringBuilder sb, final 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 a string builder
043     * @param entry a map entry
044     * @return {@code key="value"}
045     */
046    public static StringBuilder appendKeyDqValue(final StringBuilder sb, final Entry<String, String> entry) {
047        return appendKeyDqValue(sb, entry.getKey(), entry.getValue());
048    }
049
050    /**
051     * Appends in the following format: key=double quoted value.
052     * 
053     * @param sb a string builder
054     * @param key a key
055     * @param value a value
056     * @return the specified StringBuilder
057     */
058    public static StringBuilder appendKeyDqValue(final StringBuilder sb, final String key, final Object value) {
059        return sb.append(key).append(Chars.EQ).append(Chars.DQUOTE).append(value).append(Chars.DQUOTE);
060    }
061
062}