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