src/java/org/apache/commons/lang/WordWrapUtils.java - platform/external/apache-commons-lang - Git at Google

 /* ====================================================================
  * The Apache Software License, Version 1.1
  *
  * Copyright (c) 2002-2003 The Apache Software Foundation.  All rights
  * reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  *
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in
  *    the documentation and/or other materials provided with the
  *    distribution.
  *
  * 3. The end-user documentation included with the redistribution, if
  *    any, must include the following acknowlegement:
  *       "This product includes software developed by the
  *        Apache Software Foundation (http://www.apache.org/)."
  *    Alternately, this acknowlegement may appear in the software itself,
  *    if and wherever such third-party acknowlegements normally appear.
  *
  * 4. The names "The Jakarta Project", "Commons", and "Apache Software
  *    Foundation" must not be used to endorse or promote products derived
  *    from this software without prior written permission. For written
  *    permission, please contact apache@apache.org.
  *
  * 5. Products derived from this software may not be called "Apache"
  *    nor may "Apache" appear in their names without prior written
  *    permission of the Apache Software Foundation.
  *
  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  * ====================================================================
  *
  * This software consists of voluntary contributions made by many
  * individuals on behalf of the Apache Software Foundation.  For more
  * information on the Apache Software Foundation, please see
  * <http://www.apache.org/>.
  */
 package org.apache.commons.lang;

 import java.util.NoSuchElementException;
 import java.util.StringTokenizer;

 /**
  * <p><code>WordWrapUtils</code> is a utility class to assist with word wrapping.</p>
  *
  * <p>This class tries to handle <code>null</code> input gracefully.
  * An exception will not be thrown for a <code>null</code> input.
  * Each method documents its behaviour in more detail.</p>
  *
  * @author Apache Jakarta Velocity
  * @author Henri Yandell
  * @author Stephen Colebourne
  * @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
  * @author <a href="mailto:ggregory@seagullsw.com">Gary Gregory</a>
  * @since 2.0
  * @version $Id: WordWrapUtils.java,v 1.10 2003/08/16 12:45:38 scolebourne Exp $
  */
 public class WordWrapUtils {

     /**
      * <p><code>WordWrapUtils</code> instances should NOT be constructed in
      * standard programming. Instead, the class should be used as
      * <code>WordWrapUtils.wordWrap("foo bar");</code>.</p>
      *
      * <p>This constructor is public to permit tools that require a JavaBean
      * instance to operate.</p>
      */
     public WordWrapUtils() {
     }

     // Wrapping
     //--------------------------------------------------------------------------
 //    /**
 //     * <p>Wraps a block of text to a specified line length using '\n' as
 //     * a newline.</p>
 //     *
 //     * <p>This method takes a block of text, which might have long lines in it
 //     * and wraps the long lines based on the supplied lineLength parameter.</p>
 //     *
 //     * <p>If a single word is longer than the line length (eg. a URL), it will
 //     * not be broken, and will display beyond the expected width.</p>
 //     *
 //     * <p>If there are tabs in inString, you are going to get results that are
 //     * a bit strange. Tabs are a single character but are displayed as 4 or 8
 //     * spaces. Remove the tabs.</p>
 //     *
 //     * @param str  text which is in need of word-wrapping, may be null
 //     * @param lineLength  the column to wrap the words at
 //     * @return the text with all the long lines word-wrapped
 //     *  <code>null</code> if null string input
 //     */
 //    public static String wrapText(String str, int lineLength) {
 //        return wrap(str, null, lineLength);
 //    }

     /**
      * <p>Wraps a block of text to a specified line length.</p>
      *
      * <p>This method takes a block of text, which might have long lines in it
      * and wraps the long lines based on the supplied lineLength parameter.</p>
      *
      * <p>If a single word is longer than the wrapColumn (eg. a URL), it will
      * not be broken, and will display beyond the expected width.</p>
      *
      * <p>If there are tabs in inString, you are going to get results that are
      * a bit strange. Tabs are a single character but are displayed as 4 or 8
      * spaces. Remove the tabs.</p>
      *
      * @param str  text which is in need of word-wrapping, may be null
      * @param newLineChars  the characters that define a newline, null treated as \n
      * @param lineLength  the column to wrap the words at
      * @return the text with all the long lines word-wrapped
      *  <code>null</code> if null string input
      */
     public static String wrapText(String str, String newLineChars, int lineLength) {
         if (str == null) {
             return null;
         }
         if (newLineChars == null) {
             newLineChars = "\n";
         }
         StringTokenizer lineTokenizer = new StringTokenizer(str, newLineChars, true);
         StringBuffer stringBuffer = new StringBuffer();

         while (lineTokenizer.hasMoreTokens()) {
             try {
                 String nextLine = lineTokenizer.nextToken();

                 if (nextLine.length() > lineLength) {
                     // This line is long enough to be wrapped.
                     nextLine = wrapLine(nextLine, newLineChars, lineLength);
                 }

                 stringBuffer.append(nextLine);

             } catch (NoSuchElementException nsee) {
                 // thrown by nextToken(), but I don't know why it would
                 break;
             }
         }

         return (stringBuffer.toString());
     }

     /**
      * <p>Wraps a single line of text. Called by wrapText() to do the real
      * work of wrapping.</p>
      *
      * @param line  a line which is in need of word-wrapping
      * @param newline  the characters that define a newline
      * @param lineLength  the column to wrap the words at
      * @return a line with newlines inserted
      */
     private static String wrapLine(String line, String newline, int lineLength) {
         StringBuffer wrappedLine = new StringBuffer();

         while (line.length() > lineLength) {
             int spaceToWrapAt = line.lastIndexOf(' ', lineLength);

             if (spaceToWrapAt >= 0) {
                 wrappedLine.append(line.substring(0, spaceToWrapAt));
                 wrappedLine.append(newline);
                 line = line.substring(spaceToWrapAt + 1);
             }

             // This must be a really long word or URL. Pass it
             // through unchanged even though it's longer than the
             // wrapColumn would allow. This behavior could be
             // dependent on a parameter for those situations when
             // someone wants long words broken at line length.
             else {
                 spaceToWrapAt = line.indexOf(' ', lineLength);

                 if (spaceToWrapAt >= 0) {
                     wrappedLine.append(line.substring(0, spaceToWrapAt));
                     wrappedLine.append(newline);
                     line = line.substring(spaceToWrapAt + 1);
                 } else {
                     wrappedLine.append(line);
                     line = "";
                 }
             }
         }

         // Whatever is left in line is short enough to just pass through
         wrappedLine.append(line);

         return (wrappedLine.toString());
     }

 }
	/* ====================================================================
	* The Apache Software License, Version 1.1
	*
	* Copyright (c) 2002-2003 The Apache Software Foundation. All rights
	* reserved.
	*
	* Redistribution and use in source and binary forms, with or without
	* modification, are permitted provided that the following conditions
	* are met:
	*
	* 1. Redistributions of source code must retain the above copyright
	* notice, this list of conditions and the following disclaimer.
	*
	* 2. Redistributions in binary form must reproduce the above copyright
	* notice, this list of conditions and the following disclaimer in
	* the documentation and/or other materials provided with the
	* distribution.
	*
	* 3. The end-user documentation included with the redistribution, if
	* any, must include the following acknowlegement:
	* "This product includes software developed by the
	* Apache Software Foundation (http://www.apache.org/)."
	* Alternately, this acknowlegement may appear in the software itself,
	* if and wherever such third-party acknowlegements normally appear.
	*
	* 4. The names "The Jakarta Project", "Commons", and "Apache Software
	* Foundation" must not be used to endorse or promote products derived
	* from this software without prior written permission. For written
	* permission, please contact apache@apache.org.
	*
	* 5. Products derived from this software may not be called "Apache"
	* nor may "Apache" appear in their names without prior written
	* permission of the Apache Software Foundation.
	*
	* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
	* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
	* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
	* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
	* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
	* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
	* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	* SUCH DAMAGE.
	* ====================================================================
	*
	* This software consists of voluntary contributions made by many
	* individuals on behalf of the Apache Software Foundation. For more
	* information on the Apache Software Foundation, please see
	* <http://www.apache.org/>.
	*/
	package org.apache.commons.lang;

	import java.util.NoSuchElementException;
	import java.util.StringTokenizer;

	/**
	* <p><code>WordWrapUtils</code> is a utility class to assist with word wrapping.</p>
	*
	* <p>This class tries to handle <code>null</code> input gracefully.
	* An exception will not be thrown for a <code>null</code> input.
	* Each method documents its behaviour in more detail.</p>
	*
	* @author Apache Jakarta Velocity
	* @author Henri Yandell
	* @author Stephen Colebourne
	* @author <a href="mailto:hps@intermeta.de">Henning P. Schmiedehausen</a>
	* @author <a href="mailto:ggregory@seagullsw.com">Gary Gregory</a>
	* @since 2.0
	* @version $Id: WordWrapUtils.java,v 1.10 2003/08/16 12:45:38 scolebourne Exp $
	*/
	public class WordWrapUtils {

	/**
	* <p><code>WordWrapUtils</code> instances should NOT be constructed in
	* standard programming. Instead, the class should be used as
	* <code>WordWrapUtils.wordWrap("foo bar");</code>.</p>
	*
	* <p>This constructor is public to permit tools that require a JavaBean
	* instance to operate.</p>
	*/
	public WordWrapUtils() {
	}

	// Wrapping
	//--------------------------------------------------------------------------
	// /**
	// * <p>Wraps a block of text to a specified line length using '\n' as
	// * a newline.</p>
	// *
	// * <p>This method takes a block of text, which might have long lines in it
	// * and wraps the long lines based on the supplied lineLength parameter.</p>
	// *
	// * <p>If a single word is longer than the line length (eg. a URL), it will
	// * not be broken, and will display beyond the expected width.</p>
	// *
	// * <p>If there are tabs in inString, you are going to get results that are
	// * a bit strange. Tabs are a single character but are displayed as 4 or 8
	// * spaces. Remove the tabs.</p>
	// *
	// * @param str text which is in need of word-wrapping, may be null
	// * @param lineLength the column to wrap the words at
	// * @return the text with all the long lines word-wrapped
	// * <code>null</code> if null string input
	// */
	// public static String wrapText(String str, int lineLength) {
	// return wrap(str, null, lineLength);
	// }

	/**
	* <p>Wraps a block of text to a specified line length.</p>
	*
	* <p>This method takes a block of text, which might have long lines in it
	* and wraps the long lines based on the supplied lineLength parameter.</p>
	*
	* <p>If a single word is longer than the wrapColumn (eg. a URL), it will
	* not be broken, and will display beyond the expected width.</p>
	*
	* <p>If there are tabs in inString, you are going to get results that are
	* a bit strange. Tabs are a single character but are displayed as 4 or 8
	* spaces. Remove the tabs.</p>
	*
	* @param str text which is in need of word-wrapping, may be null
	* @param newLineChars the characters that define a newline, null treated as \n
	* @param lineLength the column to wrap the words at
	* @return the text with all the long lines word-wrapped
	* <code>null</code> if null string input
	*/
	public static String wrapText(String str, String newLineChars, int lineLength) {
	if (str == null) {
	return null;
	}
	if (newLineChars == null) {
	newLineChars = "\n";
	}
	StringTokenizer lineTokenizer = new StringTokenizer(str, newLineChars, true);
	StringBuffer stringBuffer = new StringBuffer();

	while (lineTokenizer.hasMoreTokens()) {
	try {
	String nextLine = lineTokenizer.nextToken();

	if (nextLine.length() > lineLength) {
	// This line is long enough to be wrapped.
	nextLine = wrapLine(nextLine, newLineChars, lineLength);
	}

	stringBuffer.append(nextLine);

	} catch (NoSuchElementException nsee) {
	// thrown by nextToken(), but I don't know why it would
	break;
	}
	}

	return (stringBuffer.toString());
	}

	/**
	* <p>Wraps a single line of text. Called by wrapText() to do the real
	* work of wrapping.</p>
	*
	* @param line a line which is in need of word-wrapping
	* @param newline the characters that define a newline
	* @param lineLength the column to wrap the words at
	* @return a line with newlines inserted
	*/
	private static String wrapLine(String line, String newline, int lineLength) {
	StringBuffer wrappedLine = new StringBuffer();

	while (line.length() > lineLength) {
	int spaceToWrapAt = line.lastIndexOf(' ', lineLength);

	if (spaceToWrapAt >= 0) {
	wrappedLine.append(line.substring(0, spaceToWrapAt));
	wrappedLine.append(newline);
	line = line.substring(spaceToWrapAt + 1);
	}

	// This must be a really long word or URL. Pass it
	// through unchanged even though it's longer than the
	// wrapColumn would allow. This behavior could be
	// dependent on a parameter for those situations when
	// someone wants long words broken at line length.
	else {
	spaceToWrapAt = line.indexOf(' ', lineLength);

	if (spaceToWrapAt >= 0) {
	wrappedLine.append(line.substring(0, spaceToWrapAt));
	wrappedLine.append(newline);
	line = line.substring(spaceToWrapAt + 1);
	} else {
	wrappedLine.append(line);
	line = "";
	}
	}
	}

	// Whatever is left in line is short enough to just pass through
	wrappedLine.append(line);

	return (wrappedLine.toString());
	}

	}