Left pad the given text parameter

   

/*  
 * Copyright 2008-2010 the original author or authors 
 *
 * 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.
 */
//package org.kaleidofoundry.core.util;


/**
 * String Helper static method
 * 
 * @author Jerome RADUGET
 */
public abstract class StringHelper {

  /**
   * Left pad the given text parameter
   * 
   * <pre>
   * <b>Assertions:</b>
   *   assertNull(StringHelper.leftPad(null, 10));
   *   assertEquals("", StringHelper.leftPad("", 0));
   *   assertEquals(" ", StringHelper.leftPad("", 1));
   *   assertEquals("     ", StringHelper.leftPad("", 5));
   *   assertEquals("     Hello", StringHelper.leftPad("Hello", 10));
   *   assertEquals("    ", StringHelper.leftPad("    ", 0));
   *   assertEquals("    ", StringHelper.leftPad("    ", 1));
   *   assertEquals("    ", StringHelper.leftPad("    ", 3));
   * </pre>
   * 
   * @param text
   * @param size
   * @return Left pad of the given text parameter
   */
  public static String leftPad(final String text, final int size) {
    return leftPad(text, size, ' ');
  }

  /**
   * Left pad the given text parameter
   * 
   * <pre>
   * <b>Assertions:</b>
   *   assertNull(StringHelper.leftPad(null, 10, '*'));
   *   assertEquals("", StringHelper.leftPad("", 0, '*'));
   *   assertEquals("*", StringHelper.leftPad("", 1, '*'));
   *   assertEquals("*****", StringHelper.leftPad("", 5, '*'));
   *   assertEquals("*****Hello", StringHelper.leftPad("Hello", 10, '*'));
   *   assertEquals("*****", StringHelper.leftPad("*****", 0, '*'));
   *   assertEquals("*****", StringHelper.leftPad("*****", 1, '*'));
   *   assertEquals("*****", StringHelper.leftPad("*****", 3, '*'));
   * </pre>
   * 
   * @param text
   * @param size
   * @param padChar
   * @return Left pad of the given text parameter
   */
  public static String leftPad(final String text, final int size,
      final char padChar) {
    if (text == null) {
      return null;
    }

    final StringBuilder paddedText = new StringBuilder(size);
    while (paddedText.length() < size - text.length()) {
      paddedText.append(padChar);
    }

    paddedText.append(text);

    return paddedText.toString();
  }
}

Related examples in the same category

1.	Left pad a String with a specified String.
2.	Left pad a String with a specified character.
3.	Left pad a String with spaces (' ').
4.	Right pad a String with a specified String.
5.	Right pad a String with a specified character.
6.	Right pad a String with spaces (' ').
7.	Padding and triming strings
8.	Pad string
9.	Padded String
10.	Set string length, padding with character if the shorter, or truncating if longer
11.	Returns the quoted version of the string using the quotechar argument.
12.	Return a string padded with the given string for the given count.
13.	Right pad the given text parameter
14.	Left padding
15.	Right padding
16.	Pads the string with 0x and zeros on the left until it has the requested size.
17.	Pads the string with zeros on the left until it has the requested size.
18.	Right, left justify the string

Left pad the given text parameter : String Pad « Data Type « Java

Related examples in the same category