src/java/org/apache/fulcrum/yaafi/framework/util/ToStringBuilder.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.fulcrum.yaafi.framework.util;

/**
 * A simple replacement for the more involved version in commons-lang; this is used
 * to help construct the description string returned by an object's
 * <code>toString()</code> method.
 *
 * The code was pasted from the Hivemind container written by
 * Howard Lewis Ship.
 *
 * @author <a href="mailto:siegfried.goeschl@it20one.at">Siegfried Goeschl</a>
 */
public class ToStringBuilder
{
    private StringBuilder buffer = new StringBuilder();

    private int mode;
    private int attributeCount;

    private static int defaultMode = 0x03;

    public static final int INCLUDE_PACKAGE_PREFIX = 0x1;
    public static final int INCLUDE_HASHCODE = 0x02;

    public ToStringBuilder(Object target)
    {
        this(target, defaultMode);
    }

    public ToStringBuilder(Object target, int mode)
    {
        this.mode = mode;

        appendClassName(target);
        appendHashCode(target);
    }

    private void appendHashCode(Object target)
    {
        if ((this.mode & INCLUDE_HASHCODE) == 0)
            return;

        this.buffer.append('@');
        this.buffer.append(Integer.toHexString(target.hashCode()));
    }

    private void appendClassName(Object target)
    {
        String className = target.getClass().getName();

        if ((this.mode & INCLUDE_PACKAGE_PREFIX) != 0)
        {
            this.buffer.append(className);
            return;
        }

        int lastdotx = className.lastIndexOf('.');

        this.buffer.append(className.substring(lastdotx + 1));
    }

    public static int getDefaultMode()
    {
        return defaultMode;
    }

    public static void setDefaultMode(int i)
    {
        defaultMode = i;
    }

    /**
     * Returns the final assembled string. This may only be invoked once, after
     * all attributes have been appended.
     */
    public String toString()
    {
        if (this.attributeCount > 0)
            this.buffer.append(']');

        String result = this.buffer.toString();

        this.buffer = null;

        return result;
    }

    public void append(String attributeName, boolean value)
    {
        append(attributeName, String.valueOf(value));
    }

    public void append(String attributeName, byte value)
    {
        append(attributeName, String.valueOf(value));

    }
    public void append(String attributeName, short value)
    {
        append(attributeName, String.valueOf(value));
    }

    public void append(String attributeName, int value)
    {
        append(attributeName, String.valueOf(value));
    }

    public void append(String attributeName, Object value)
    {
        append(attributeName, String.valueOf(value));
    }

    public void append(String attributeName, String value)
    {
        if (this.attributeCount++ == 0)
            this.buffer.append('[');

        else
            this.buffer.append(' ');

        this.buffer.append(attributeName);

        this.buffer.append('=');

        this.buffer.append(value);
    }
}