org.zanata.util.ShortString Maven / Gradle / Ivy

Go to download
package org.zanata.util;

import java.util.ArrayList;
import java.util.List;

/**
 * ShortStrings are meant for use in logging. They don't incur the cost of
 * shortening until toString() is called. This means they hold on to the entire
 * string, so don't bother keeping them around in memory for long.
 *
 * @author Sean Flanigan [email protected]
 *
 */
public class ShortString {

    static final int MAX_LENGTH = 66;
    private static final String ELLIPSIS = "…";
    private String input;

    public ShortString(String input) {
        this.input = input;
    }

    @Override
    public String toString() {
        return input = shorten(input);
    }

    /**
     * Truncate a string to be no longer than MAX_LENGTH, using an ellipsis at
     * the end. If the string is already short enough, return the same string.
     * @param s String to shorten if required
     * @return a new String if shortening was required, otherwise s
     */
    public static String shorten(String s) {
        return shorten(s, MAX_LENGTH);
    }

    /**
     * Truncate a string to be no longer than maxLength, using an ellipsis at
     * the end. If the string is already short enough, return the same string.
     * @param s String to shorten if required
     * @param maxLength length to shorten string to
     * @return a new String if shortening was required, otherwise s
     */
    public static String shorten(String s, int maxLength) {
        if (s.length() <= maxLength) {
            return s;
        }
        return s.substring(0, maxLength - ELLIPSIS.length()) + ELLIPSIS;
    }

    /**
     * @param strings
     * @return
     */
    public static String shorten(List strings) {
        List shortStrings = new ArrayList(strings.size());
        for (String s : strings) {
            shortStrings.add(shorten(s));
        }
        return shortStrings.toString();
    }

}