Java String Truncate truncate(String string, int maxLength, boolean atBeginning, String ellipse)

Description

Returns a truncated version of the string, where the removed part is marked by ellipse.

License

Open Source License

Declaration

public static String truncate(String string, int maxLength, boolean atBeginning, String ellipse) 

Method Source Code

//package com.java2s;
/*/*from ww w . j av a 2 s .  c  o m*/
 * The MIT License (MIT)
 * 
 * Copyright (c) 2010 Technische Universitaet Berlin
 * 
 * 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:
 * 
 * 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 {
    /**
     * Returns a truncated version of the string, where the removed part is marked by
     * <code>ellipse</code>.
     */

    public static String truncate(String string, int maxLength, boolean atBeginning, String ellipse) {
        int length = string.length();
        int removedLength = length - maxLength - ellipse.length();
        if (removedLength > 0) {
            string = (atBeginning ? ellipse + string.substring(removedLength)
                    : string.substring(0, length - removedLength) + ellipse);
        }
        return string;
    }

    /**
     * Same as {@link #truncate(String,int,boolean,String) truncate(string, maxLength, atBeginning, "[...]")}.
     */

    public static String truncate(String string, int maxLength, boolean atBeginning) {
        return truncate(string, maxLength, atBeginning, "[...]");
    }
}

Related

1. truncate(String str, int size, boolean useEllipsis)
2. truncate(String str, int start, int end)
3. truncate(String str, String prefix, String suffix)
4. truncate(String string, final int length)
5. truncate(String string, int length)
6. truncate(String string, int maxSize)
7. truncate(String string, int n, String suffix)
8. truncate(String strOrginal, int iByteMaxSize)
9. truncate(String text)