/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License. You can obtain
 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
 * or glassfish/bootstrap/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
 * Sun designates this particular file as subject to the "Classpath" exception
 * as provided by Sun in the GPL Version 2 section of the License file that
 * accompanied this code.  If applicable, add the following below the License
 * Header, with the fields enclosed by brackets [] replaced by your own
 * identifying information: "Portions Copyrighted [year]
 * [name of copyright owner]"
 * 
 * Contributor(s):
 * 
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package com.sun.enterprise.admin.util;

// JDK classes
import java.io.ByteArrayOutputStream;
import java.io.PrintStream;

// our classes
import com.sun.enterprise.admin.util.Assert;


/**
	Exists to convert a Throwable to a String.  This gives more control
	than having a printStackTrace() go directly to a PrintStream
	or PrintWriter.  It also defers the conversion to a String until a later
	time when the caller finds it convenient.
 */
public final class ThrowableToString
{
	private final static int	kDefaultBufferSize	= 512;
	
	private final Throwable	mThrowable;
	
	/**
		Constructor--takes any non-null Throwable
		
		@param throwable	any Throwable
	 */
		public 
	ThrowableToString( Throwable  throwable )
	{
		Assert.assertit( throwable != null, "null throwable" );
		mThrowable	= throwable;
	}
	
	/**
		Convert the Throwable to a String.
	 */
		public String
	toString()
	{
    	final ByteArrayOutputStream	output	=
    								new ByteArrayOutputStream( kDefaultBufferSize );
    	final PrintStream		print	= new PrintStream( output );
    	
        mThrowable.printStackTrace( print );
        
        return( output.toString() );
	}
}