com.openpojo.reflection.utils.ToStringHelper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openpojo Show documentation

This project was born out of a need to validate all POJOs (Plain Old Java Object) are behaving correctly. This project has two main aspects to it: * Make Testing as easy as possible. * Simplifying identity management (hashCode / equals) using annotation.

There is a newer version: 0.7.3

Show newest version

/*
 * Copyright (c) 2010-2013 Osman Shoukry
 *
 *    This program 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 any
 *    later version.
 *
 *    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 program.  If not, see .
 */

package com.openpojo.reflection.utils;

import com.openpojo.reflection.PojoClass;
import com.openpojo.reflection.PojoField;

import java.util.List;

/**
 * This class is a collection of commonly used functions used for various toString(Object) calls.
 * @author oshoukry
 */
public final class ToStringHelper {
    public static final String NAME_VALUE_TOKEN_FORMAT = "%s=%s";
    public static final String LIST_TOKEN_SEPERATOR = ", ";
    public static final String POJOCLASS_TOSTRING_FORMAT = "%s [@%s: %s]";

    /**
     * This method formats name value pairs into the proper string format.
     * @param name
     *          The name to format.
     * @param value
     *          The value to format.
     * @return
     *          String formatted, human readable name/value pair.
     */
    public static String nameValuePair(final Object name, final Object value) {
        return String.format(NAME_VALUE_TOKEN_FORMAT, name, value);
    }

    /**
     * This method takes an object instance for a pojoClass and flattens it into a properly formatted string.
     *
     * @param pojoClass
     *          The meta representation of the instance class.
     * @param instance
     *          The instance to format.
     * @return
     *          String formatted, human readable class.
     */
    public static String pojoClassToString(final PojoClass pojoClass, final Object instance) {
        return String.format(POJOCLASS_TOSTRING_FORMAT,
                                pojoClass.getName(),
                                Integer.toHexString(System.identityHashCode(instance)),
                                PojoFieldsToString(pojoClass.getPojoFields(), instance));
    }

    /**
     * This method takes a list of PojoFields and turns them into token separated name-value pairs.
     * @param pojoFields
     *          The list of pojoFields to render.
     * @param instance
     *          The object instance to get the values out of.
     * @return
     *          String formatted, human readable list of pojoFields.
     */
    private static String PojoFieldsToString(final List pojoFields, final Object instance) {
        String pojoString = "";
        for (int index = 0; index < pojoFields.size(); index++) {
            pojoString += pojoFields.get(index).toString(instance);
            if (index < pojoFields.size() - 1) {
                pojoString += LIST_TOKEN_SEPERATOR;
            }
        }
        return pojoString;
    }
}