| 1 | /*
|
|---|
| 2 | * Copyright 2004 The Apache Software Foundation
|
|---|
| 3 | *
|
|---|
| 4 | * Licensed under the Apache License, Version 2.0 (the "License");
|
|---|
| 5 | * you may not use this file except in compliance with the License.
|
|---|
| 6 | * You may obtain a copy of the License at
|
|---|
| 7 | *
|
|---|
| 8 | * http://www.apache.org/licenses/LICENSE-2.0
|
|---|
| 9 | *
|
|---|
| 10 | * Unless required by applicable law or agreed to in writing, software
|
|---|
| 11 | * distributed under the License is distributed on an "AS IS" BASIS,
|
|---|
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|---|
| 13 | * See the License for the specific language governing permissions and
|
|---|
| 14 | * limitations under the License.
|
|---|
| 15 | *
|
|---|
| 16 | */
|
|---|
| 17 |
|
|---|
| 18 | package org.apache.tools.ant;
|
|---|
| 19 |
|
|---|
| 20 | /**
|
|---|
| 21 | * Instances of classes that implement this interface can register
|
|---|
| 22 | * to be also notified when things happened during a subbuild.
|
|---|
| 23 | *
|
|---|
| 24 | * <p>A subbuild is a separate project instance created by the
|
|---|
| 25 | * <code><ant></code> task family. These project instances will
|
|---|
| 26 | * never fire the buildStarted and buildFinished events, but they will
|
|---|
| 27 | * fire subBuildStarted/ and subBuildFinished. The main project
|
|---|
| 28 | * instance - the one created by running Ant in the first place - will
|
|---|
| 29 | * never invoke one of the methods of this interface.</p>
|
|---|
| 30 | *
|
|---|
| 31 | * @see BuildEvent
|
|---|
| 32 | * @see Project#addBuildListener(BuildListener)
|
|---|
| 33 | *
|
|---|
| 34 | * @since Ant 1.6.2
|
|---|
| 35 | */
|
|---|
| 36 | public interface SubBuildListener extends BuildListener {
|
|---|
| 37 |
|
|---|
| 38 | /**
|
|---|
| 39 | * Signals that a subbuild has started. This event
|
|---|
| 40 | * is fired before any targets have started.
|
|---|
| 41 | *
|
|---|
| 42 | * @param event An event with any relevant extra information.
|
|---|
| 43 | * Must not be <code>null</code>.
|
|---|
| 44 | */
|
|---|
| 45 | void subBuildStarted(BuildEvent event);
|
|---|
| 46 |
|
|---|
| 47 | /**
|
|---|
| 48 | * Signals that the last target has finished. This event
|
|---|
| 49 | * will still be fired if an error occurred during the build.
|
|---|
| 50 | *
|
|---|
| 51 | * @param event An event with any relevant extra information.
|
|---|
| 52 | * Must not be <code>null</code>.
|
|---|
| 53 | *
|
|---|
| 54 | * @see BuildEvent#getException()
|
|---|
| 55 | */
|
|---|
| 56 | void subBuildFinished(BuildEvent event);
|
|---|
| 57 | }
|
|---|
