StringBuilderUtil.java

/**
 * OpenSpotLight - Open Source IT Governance Platform
 *
 * Copyright (c) 2009, CARAVELATECH CONSULTORIA E TECNOLOGIA EM INFORMATICA LTDA
 * or third-party contributors as indicated by the @author tags or express
 * copyright attribution statements applied by the authors.  All third-party
 * contributions are distributed under license by CARAVELATECH CONSULTORIA E
 * TECNOLOGIA EM INFORMATICA LTDA.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * See the GNU Lesser General Public License  for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 *
 ***********************************************************************
 * OpenSpotLight - Plataforma de Governança de TI de Código Aberto
 *
 * Direitos Autorais Reservados (c) 2009, CARAVELATECH CONSULTORIA E TECNOLOGIA
 * EM INFORMATICA LTDA ou como contribuidores terceiros indicados pela etiqueta
 * @author ou por expressa atribuição de direito autoral declarada e atribuída pelo autor.
 * Todas as contribuições de terceiros estão distribuídas sob licença da
 * CARAVELATECH CONSULTORIA E TECNOLOGIA EM INFORMATICA LTDA.
 *
 * Este programa é software livre; você pode redistribuí-lo e/ou modificá-lo sob os
 * termos da Licença Pública Geral Menor do GNU conforme publicada pela Free Software
 * Foundation.
 *
 * Este programa é distribuído na expectativa de que seja útil, porém, SEM NENHUMA
 * GARANTIA; nem mesmo a garantia implícita de COMERCIABILIDADE OU ADEQUAÇÃO A UMA
 * FINALIDADE ESPECÍFICA. Consulte a Licença Pública Geral Menor do GNU para mais detalhes.
 *
 * Você deve ter recebido uma cópia da Licença Pública Geral Menor do GNU junto com este
 * programa; se não, escreva para:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */

package org.openspotlight.common.util;

import java.util.List;

/**
 * The Class StringBuilderUtil.
 * 
 * @author Vitor Hugo Chagas
 */
public class StringBuilderUtil {

    /**
     * Append values.
     * 
     * @param buffer the buffer
     * @param values the values
     * @return the string builder
     */
    public static StringBuilder append(final StringBuilder buffer,
                                        final List<?> values) {
        for (final Object value: values) {
            buffer.append(value);
        }
        return buffer;
    }

    /**
     * Append value if not null.
     * 
     * @param buffer the buffer
     * @param value the value
     * @return the string builder
     */
    public static StringBuilder append(final StringBuilder buffer,
                                        final Object value) {
        if (value != null) {
            buffer.append(value);
        }
        return buffer;
    }

    /**
     * Append values.
     * 
     * @param buffer the buffer
     * @param values the values
     * @return the string builder
     */
    public static StringBuilder append(final StringBuilder buffer,
                                        final Object... values) {
        for (final Object value: values) {
            buffer.append(value);
        }
        return buffer;
    }

    /**
     * Append values if value is not null.
     * 
     * @param buffer the buffer
     * @param value the value
     * @param values the values
     * @return true, if successful
     */
    public static StringBuilder appendIfNotNull(final StringBuilder buffer,
                                                 final Object value,
                                                 final Object... values) {
        if (value != null) {
            for (final Object current: values) {
                if (current != null) {
                    buffer.append(current);
                }
            }
        }
        return buffer;
    }

    /**
     * Append values and add a carriage return.
     * 
     * @param buffer the buffer
     * @param values the values
     * @return the string builder
     */
    public static StringBuilder appendLine(StringBuilder buffer,
                                            final List<?> values) {
        buffer = append(buffer, values);
        buffer.append("\n");
        return buffer;
    }

}