From 8507f140157636fb090466461c9160a2cfd16d82 Mon Sep 17 00:00:00 2001 From: Uwe Stieber Date: Sat, 30 Dec 2006 19:04:04 +0000 Subject: [PATCH] [cleanup] Add missing javadoc comments and fix copyright header --- .../core/IRSETestLogCollectorDelegate.java | 17 +++++++++++++++++ .../eclipse/rse/tests/core/RSECoreTestCase.java | 15 ++++++++------- 2 files changed, 25 insertions(+), 7 deletions(-) diff --git a/rse/tests/org.eclipse.rse.tests/src/org/eclipse/rse/tests/core/IRSETestLogCollectorDelegate.java b/rse/tests/org.eclipse.rse.tests/src/org/eclipse/rse/tests/core/IRSETestLogCollectorDelegate.java index 0fef1564fcb..dca415c7efd 100644 --- a/rse/tests/org.eclipse.rse.tests/src/org/eclipse/rse/tests/core/IRSETestLogCollectorDelegate.java +++ b/rse/tests/org.eclipse.rse.tests/src/org/eclipse/rse/tests/core/IRSETestLogCollectorDelegate.java @@ -19,7 +19,24 @@ import org.eclipse.core.runtime.IPath; */ public interface IRSETestLogCollectorDelegate { + /** + * Returns the list of absolute file locations to included + * within the collected logs archive file. The returned + * absolute file locations must denote real existing files. + * Possible dynamic content to collect can be written to + * temporary files. The log collector delegate is responsible + * for removing these temporary files if the dispose() + * method is called. + * + * @return An array of absolute file locations. + */ public IPath[] getAbsoluteLogFileLocations(); + /** + * Signal the RSE test log collector delegate to dispose + * any resource created. Possibly created temporary files + * should be deleted. Open streams or handles should be + * closed. + */ public void dispose(); } diff --git a/rse/tests/org.eclipse.rse.tests/src/org/eclipse/rse/tests/core/RSECoreTestCase.java b/rse/tests/org.eclipse.rse.tests/src/org/eclipse/rse/tests/core/RSECoreTestCase.java index 01309044957..145b9d3845f 100644 --- a/rse/tests/org.eclipse.rse.tests/src/org/eclipse/rse/tests/core/RSECoreTestCase.java +++ b/rse/tests/org.eclipse.rse.tests/src/org/eclipse/rse/tests/core/RSECoreTestCase.java @@ -1,13 +1,14 @@ -/* ******************************************************************************* - * Copyright (c) 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 +/******************************************************************************** + * Copyright (c) 2006 Wind River Systems, Inc. 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: - * Uwe Stieber (Wind River) - initial contribution. + * Uwe Stieber (Wind River) - initial API and implementation. * Martin Oberhuber (Wind River) - fix build against 3.2.1, fix javadoc errors - * *******************************************************************************/ + ********************************************************************************/ package org.eclipse.rse.tests.core; import java.io.BufferedInputStream;