com.googlecode.markuputils.MarkupBuilder.java Source code

Introduction

Here is the source code for com.googlecode.markuputils.MarkupBuilder.java

Source

/*
 * This file is part of MarkupUtils.
 *
 * MarkupUtils is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MarkupUtils 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 MarkupUtils.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Copyright (c) 2009 Filippo De Luca
 */
package com.googlecode.markuputils;

import java.io.Serializable;

import org.apache.commons.lang.SystemUtils;
import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;

/**
 * This class is intended helping to build HTML like markup.
 * 
 * @author Filippo De Luca
 * @version $Id$
 */
public class MarkupBuilder implements Serializable {

    private static final long serialVersionUID = 10L;

    private final StringBuilder buffer = new StringBuilder();

    /**
     * Start open element, appending &quot;&lt;&quot; plus element name.
     * <p>
     * Ex: &quot;&lt;div&quot;
     * </p>
     * 
     * @param name
     *            The name of the element to start
     * @return a reference to this builder.
     */
    public MarkupBuilder startOpenElement(String name) {

        buffer.append(MarkupUtils.startOpenElement(name));

        return this;
    }

    /**
     * End open element appending &quot;&gt;&quot;.
     * <p>
     * Ex: &quot;&gt;&quot;
     * </p>
     * 
     * @return a reference to this builder.
     */
    public MarkupBuilder endOpenElement() {

        buffer.append(MarkupUtils.endOpenElement());

        return this;
    }

    /**
     * Opens element, appending &quot;&lt;&quot;, element name and
     * &quot;&gt;&quot;.
     * <p>
     * Ex: &quot;&lt;div&gt&quot;.
     * </p>
     * 
     * @param name
     *            The name of the element to open
     * @return a reference to this builder.
     */
    public MarkupBuilder openElement(String name) {

        buffer.append(MarkupUtils.openElement(name));

        return this;
    }

    /**
     * Closes element, appending &quot;&lt;/&quot;, element name and
     * &quot;&gt;&quot;.
     * <p>
     * Ex: &quot;&lt;/div&gt&quot;.
     * </p>
     * 
     * @param name
     *            The name of the element to close
     * @return a reference to this builder.
     */
    public MarkupBuilder closeElement(String name) {

        buffer.append(MarkupUtils.closeElement(name));

        return this;
    }

    /**
     * Append open-close element, appending &quot;&lt;&quot;, element name and
     * &quot;/&gt;&quot;.
     * <p>
     * Ex: &quot;&lt;div/&gt&quot;.
     * </p>
     * 
     * @param name
     *            The name of the element to append
     * @return a reference to this builder.
     */
    public MarkupBuilder openCloseElement(String name) {

        buffer.append(MarkupUtils.openCloseElement(name));

        return this;
    }

    /**
     * Ends open-close element, appending &quot;/&gt;&quot;.
     * <p>
     * Ex: &quot;/&gt&quot;.
     * </p>
     * 
     * @return a reference to this builder.
     */
    public MarkupBuilder endOpenCloseElement() {

        buffer.append(MarkupUtils.endOpenCloseElement());

        return this;
    }

    /**
     * Appends text to this builder.
     * 
     * @param text
     *            The text to append.
     * @return a reference to this builder.
     */
    public MarkupBuilder appendText(String text) {

        buffer.append(MarkupUtils.appendText(text));

        return this;
    }

    /**
     * Appends new line to this builder.
     * 
     * @return a reference to this builder.
     */
    public MarkupBuilder appendNewLine() {

        buffer.append(SystemUtils.LINE_SEPARATOR);

        return this;
    }

    /**
     * Appends attribute to started element. If the attribute value is blank,
     * the builder does nothing.
     * <p>
     * Ex: class=&quot;foo&quot;
     * <p>
     * 
     * @param name The name of attribute to append.
     * @param value The value of attribute to append.
     * @return a reference to this builder.
     */
    public MarkupBuilder appendAttribute(String name, String value) {

        buffer.append(MarkupUtils.appendAttribute(name, value));

        return this;
    }

    public MarkupBuilder appendNullableAttribute(String name, String value) {

        buffer.append(MarkupUtils.appendNullableAttribute(name, value));

        return this;
    }

    /**
     * Append a comment.
     * <p>
     * Ex: &lt;!-- comment --&gt;
     * 
     * @param comment The comment to append.
     * @return a reference to this builder.
     */
    public MarkupBuilder appendComment(String comment) {

        buffer.append(MarkupUtils.appendComment(comment));

        return this;

    }

    /**
     * Return the generated markup.
     * 
     * @return Generated markup.
     */
    public String toMarkup() {
        return buffer.toString();
    }

    // Commons methods ****************************************************

    @Override
    public String toString() {

        return toMarkup();
    }

    @Override
    public boolean equals(Object obj) {
        EqualsBuilder builder = new EqualsBuilder();

        if (obj instanceof MarkupBuilder) {
            MarkupBuilder other = (MarkupBuilder) obj;
            builder.append(buffer, other.buffer);
        } else {
            builder.appendSuper(false);
        }

        return builder.isEquals();
    }

    @Override
    public int hashCode() {
        HashCodeBuilder builder = new HashCodeBuilder();

        builder.append(getClass()).append(buffer);

        return builder.toHashCode();
    }

}