org.eclipse.core.commands.util.Tracing Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2005, 2006 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.core.commands.util;
/**
*
* A utility class for printing tracing output to the console.
*
*
* Clients must not extend or instantiate this class.
*
*
* @since 3.2
*/
public final class Tracing {
/**
* The separator to place between the component and the message.
*/
public static final String SEPARATOR = " >>> "; //$NON-NLS-1$
/**
*
* Prints a tracing message to standard out. The message is prefixed by a
* component identifier and some separator. See the example below.
*
*
*
* BINDINGS >> There are 4 deletion markers
*
*
* @param component
* The component for which this tracing applies; may be
* null
* @param message
* The message to print to standard out; may be null.
*/
public static final void printTrace(final String component,
final String message) {
StringBuffer buffer = new StringBuffer();
if (component != null) {
buffer.append(component);
}
if ((component != null) && (message != null)) {
buffer.append(SEPARATOR);
}
if (message != null) {
buffer.append(message);
}
System.out.println(buffer.toString());
}
/**
* This class is not intended to be instantiated.
*/
private Tracing() {
// Do nothing.
}
}