Java String Truncate truncate(String str, int size, boolean useEllipsis)

Description

Truncate a string to a certain number of characters.

License

Apache License

Parameter

Parameter	Description
str	The string to truncate.
size	The maximum number of characters.
useEllipsis	If true, add "..." to the truncated string to show it's been truncated.

Return

The truncated String, with ellipsis if specified.

Declaration

public static String truncate(String str, int size, boolean useEllipsis) 

Method Source Code

//package com.java2s;
/*//  w ww  .  java 2s.  c o m
 * Copyright [1999-2015] Wellcome Trust Sanger Institute and the EMBL-European Bioinformatics Institute
 * Copyright [2016-2018] EMBL-European Bioinformatics Institute
 * 
 * Licensed 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.
 */

public class Main {
    /**
     * Truncate a string to a certain number of characters.
     * 
     * @param str
     *            The string to truncate.
     * @param size
     *            The maximum number of characters.
     * @param useEllipsis
     *            If true, add "..." to the truncated string to show it's been
     *            truncated.
     * @return The truncated String, with ellipsis if specified.
     */
    public static String truncate(String str, int size, boolean useEllipsis) {

        String result = str;

        if (str != null && str.length() > size) {

            result = str.substring(0, size);

            if (useEllipsis) {
                result += "...";
            }
        }

        return result;

    }
}

Related

1. truncate(String str, int max)
2. truncate(String str, int maxLen)
3. truncate(String str, int maxSize)
4. truncate(String str, int maxSize)
5. truncate(String str, int n)
6. truncate(String str, int start, int end)
7. truncate(String str, String prefix, String suffix)
8. truncate(String string, final int length)
9. truncate(String string, int length)