Java String Truncate truncateString(String string, int maxLength)

Description

Truncates a string to have at maximum maxLength characters.
Where truncation is necessary an ellipsis is appended to the truncated string.

License

Open Source License

Parameter

Parameter	Description
string	the string to truncate
maxLength	the maximum acceptable length

Return

a truncated copy of the original string

Declaration

public static String truncateString(String string, int maxLength) 

Method Source Code

//package com.java2s;
/*/*from w w  w. j av a 2  s .  c  o m*/
 * Modified MIT License
 * 
 * Copyright (c) 2006-2007 Houdah Software s.? r.l.
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * Except as contained in this notice, the name(s) of the above copyright holders
 * shall not be used in advertising or otherwise to promote the sale, use or other 
 * dealings in this Software without prior written authorization.
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
**/

public class Main {
    protected static final String ELLIPSIS = "...";

    /**
     * Truncates a string to have at maximum maxLength characters.<br/>
     * 
     * Where truncation is necessary an ellipsis is appended to the truncated
     * string. The resulting string, ellipsis included, will be maxLength
     * characters long.
     * 
     * @param string
     *            the string to truncate
     * @param maxLength
     *            the maximum acceptable length
     * @return a truncated copy of the original string
     */
    public static String truncateString(String string, int maxLength) {
        if ((string != null) && (string.length() > maxLength)) {
            return string.substring(0, maxLength - ELLIPSIS.length() + 1) + ELLIPSIS;
        } else {
            return string;
        }
    }
}

Related

1. truncateString(String str, int length)
2. truncateString(String str, int length, String suffix)
3. truncateString(String str, int maxlen)
4. truncateString(String str, int size)
5. truncateString(String str, int toLen)
6. truncateString(String text, int truncateAt)
7. truncateStringAt(String source, int len)
8. truncateStringChars(String strIn, String substituteChars, int maxChars, boolean keepRightSide)
9. truncateStringToUtf8(final String original, final int maxBytes)