Abbreviates a String using ellipses. : String Format « Data Type « Java Tutorial






/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 {
  // Abbreviating
  //-----------------------------------------------------------------------
  /**
   * Abbreviates a String using ellipses. This will turn
   * "Now is the time for all good men" into "Now is the time for..."
   *
   * Specifically:
   * <ul>
   *   <li>If <code>str</code> is less than <code>maxWidth</code> characters
   *       long, return it.</li>
   *   <li>Else abbreviate it to <code>(substring(str, 0, max-3) + "...")</code>.</li>
   *   <li>If <code>maxWidth</code> is less than <code>4</code>, throw an
   *       <code>IllegalArgumentException</code>.</li>
   *   <li>In no case will it return a String of length greater than
   *       <code>maxWidth</code>.</li>
   * </ul>
   * 
   *
   * <pre>
   * StringUtils.abbreviate(null, *)      = null
   * StringUtils.abbreviate("", 4)        = ""
   * StringUtils.abbreviate("abcdefg", 6) = "abc..."
   * StringUtils.abbreviate("abcdefg", 7) = "abcdefg"
   * StringUtils.abbreviate("abcdefg", 8) = "abcdefg"
   * StringUtils.abbreviate("abcdefg", 4) = "a..."
   * StringUtils.abbreviate("abcdefg", 3) = IllegalArgumentException
   * </pre>
   *
   * @param str  the String to check, may be null
   * @param maxWidth  maximum length of result String, must be at least 4
   * @return abbreviated String, <code>null</code> if null String input
   * @throws IllegalArgumentException if the width is too small
   * @since 2.0
   */
  public static String abbreviate(String str, int maxWidth) {
      return abbreviate(str, 0, maxWidth);
  }
  /**
   * Abbreviates a String using ellipses. This will turn
   * "Now is the time for all good men" into "...is the time for..."
   *
   * Works like <code>abbreviate(String, int)</code>, but allows you to specify
   * a "left edge" offset.  Note that this left edge is not necessarily going to
   * be the leftmost character in the result, or the first character following the
   * ellipses, but it will appear somewhere in the result.
   *
   * In no case will it return a String of length greater than
   * <code>maxWidth</code>.
   *
   * <pre>
   * StringUtils.abbreviate(null, *, *)                = null
   * StringUtils.abbreviate("", 0, 4)                  = ""
   * StringUtils.abbreviate("abcdefghijklmno", -1, 10) = "abcdefg..."
   * StringUtils.abbreviate("abcdefghijklmno", 0, 10)  = "abcdefg..."
   * StringUtils.abbreviate("abcdefghijklmno", 1, 10)  = "abcdefg..."
   * StringUtils.abbreviate("abcdefghijklmno", 4, 10)  = "abcdefg..."
   * StringUtils.abbreviate("abcdefghijklmno", 5, 10)  = "...fghi..."
   * StringUtils.abbreviate("abcdefghijklmno", 6, 10)  = "...ghij..."
   * StringUtils.abbreviate("abcdefghijklmno", 8, 10)  = "...ijklmno"
   * StringUtils.abbreviate("abcdefghijklmno", 10, 10) = "...ijklmno"
   * StringUtils.abbreviate("abcdefghijklmno", 12, 10) = "...ijklmno"
   * StringUtils.abbreviate("abcdefghij", 0, 3)        = IllegalArgumentException
   * StringUtils.abbreviate("abcdefghij", 5, 6)        = IllegalArgumentException
   * </pre>
   *
   * @param str  the String to check, may be null
   * @param offset  left edge of source String
   * @param maxWidth  maximum length of result String, must be at least 4
   * @return abbreviated String, <code>null</code> if null String input
   * @throws IllegalArgumentException if the width is too small
   * @since 2.0
   */
  public static String abbreviate(String str, int offset, int maxWidth) {
      if (str == null) {
          return null;
      }
      if (maxWidth < 4) {
          throw new IllegalArgumentException("Minimum abbreviation width is 4");
      }
      if (str.length() <= maxWidth) {
          return str;
      }
      if (offset > str.length()) {
          offset = str.length();
      }
      if ((str.length() - offset) < (maxWidth - 3)) {
          offset = str.length() - (maxWidth - 3);
      }
      if (offset <= 4) {
          return str.substring(0, maxWidth - 3) + "...";
      }
      if (maxWidth < 7) {
          throw new IllegalArgumentException("Minimum abbreviation width with offset is 7");
      }
      if ((offset + (maxWidth - 3)) < str.length()) {
          return "..." + abbreviate(str.substring(offset), maxWidth - 3);
      }
      return "..." + str.substring(str.length() - (maxWidth - 3));
  }
}








2.30.String Format
2.30.1.Format Calendar with String.format()
2.30.2.Format strings into table
2.30.3.String.format(): right pad a string
2.30.4.String.format(): left pad a string
2.30.5.Format a String (JDK1.5)
2.30.6.Pass value array to String.format()
2.30.7.Remove/collapse multiple newline characters.
2.30.8.Abbreviate string
2.30.9.Capital and uncapital strings
2.30.10.Transforms words to singular, plural, humanized (human readable), underscore, camel case, or ordinal form
2.30.11.Replace New Lines
2.30.12.Fix Line Separator
2.30.13.Abbreviates a String using ellipses in both sides.
2.30.14.Abbreviates a String using ellipses.
2.30.15.Capitalize the first character of the given string
2.30.16.Centers a String in a larger String of size size using the space character (' ').
2.30.17.Centers a String in a larger String of size size. Uses a supplied String as the value to pad the String with.
2.30.18.Centers a String in a larger String of size size. Uses a supplied character as the value to pad the String with.
2.30.19.Convert string to uppercase
2.30.20.Left pad a String with a specified String.
2.30.21.Left pad a String with a specified character.
2.30.22.Left pad a String with spaces (' ').
2.30.23.Makes the first letter caps and the rest lowercase.
2.30.24.Put quotes around the given String if necessary.
2.30.25.Quote a string so that it can be used as an identifier or a string literal in SQL statements.
2.30.26.Right pad a String with a specified String.
2.30.27.Right pad a String with a specified character.
2.30.28.Right pad a String with spaces (' ').
2.30.29.Trim off trailing blanks but not leading blanks
2.30.30.Truncate a String to the given length with no warnings or error raised if it is bigger.
2.30.31.Uncapitalizes a String changing the first letter to title case as per Character.toLowerCase(char). No other letters are changed.
2.30.32.Repeat String
2.30.33.Repeat a String repeat times to form a new String.
2.30.34.Strip Line Breaks
2.30.35.Trim any of the characters
2.30.36.Removes one newline from end of a String if it's there, otherwise leave it alone.
2.30.37.Removes newline, carriage return and tab characters from a string
2.30.38.Remove the leading and trailing quotes from str.