1*fb3fb4f3Stomee /*
2*fb3fb4f3Stomee  * CDDL HEADER START
3*fb3fb4f3Stomee  *
4*fb3fb4f3Stomee  * The contents of this file are subject to the terms of the
5*fb3fb4f3Stomee  * Common Development and Distribution License (the "License").
6*fb3fb4f3Stomee  * You may not use this file except in compliance with the License.
7*fb3fb4f3Stomee  *
8*fb3fb4f3Stomee  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9*fb3fb4f3Stomee  * or http://www.opensolaris.org/os/licensing.
10*fb3fb4f3Stomee  * See the License for the specific language governing permissions
11*fb3fb4f3Stomee  * and limitations under the License.
12*fb3fb4f3Stomee  *
13*fb3fb4f3Stomee  * When distributing Covered Code, include this CDDL HEADER in each
14*fb3fb4f3Stomee  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15*fb3fb4f3Stomee  * If applicable, add the following below this CDDL HEADER, with the
16*fb3fb4f3Stomee  * fields enclosed by brackets "[]" replaced with your own identifying
17*fb3fb4f3Stomee  * information: Portions Copyright [yyyy] [name of copyright owner]
18*fb3fb4f3Stomee  *
19*fb3fb4f3Stomee  * CDDL HEADER END
20*fb3fb4f3Stomee  */
21*fb3fb4f3Stomee 
22*fb3fb4f3Stomee /*
23*fb3fb4f3Stomee  * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
24*fb3fb4f3Stomee  * Use is subject to license terms.
25*fb3fb4f3Stomee  *
26*fb3fb4f3Stomee  * ident	"%Z%%M%	%I%	%E% SMI"
27*fb3fb4f3Stomee  */
28*fb3fb4f3Stomee package org.opensolaris.os.dtrace;
29*fb3fb4f3Stomee 
30*fb3fb4f3Stomee /**
31*fb3fb4f3Stomee  * An abstract adapter class for getting events from a {@link Consumer}.
32*fb3fb4f3Stomee  * The methods in this class are empty except for a few that implement
33*fb3fb4f3Stomee  * the default behavior of terminating a consumer by throwing an
34*fb3fb4f3Stomee  * exception.  This class exists as a convenience for implementing
35*fb3fb4f3Stomee  * consumer listeners.
36*fb3fb4f3Stomee  *
37*fb3fb4f3Stomee  * @see Consumer#addConsumerListener(ConsumerListener l)
38*fb3fb4f3Stomee  *
39*fb3fb4f3Stomee  * @author Tom Erickson
40*fb3fb4f3Stomee  */
41*fb3fb4f3Stomee public abstract class ConsumerAdapter implements ConsumerListener {
42*fb3fb4f3Stomee     /** Empty method */
dataReceived(DataEvent e)43*fb3fb4f3Stomee     public void dataReceived(DataEvent e) throws ConsumerException {}
44*fb3fb4f3Stomee 
45*fb3fb4f3Stomee     /**
46*fb3fb4f3Stomee      * Terminates a running {@link Consumer} by throwing an exception.
47*fb3fb4f3Stomee      *
48*fb3fb4f3Stomee      * @throws ConsumerException
49*fb3fb4f3Stomee      */
50*fb3fb4f3Stomee     public void
dataDropped(DropEvent e)51*fb3fb4f3Stomee     dataDropped(DropEvent e) throws ConsumerException
52*fb3fb4f3Stomee     {
53*fb3fb4f3Stomee 	Drop drop = e.getDrop();
54*fb3fb4f3Stomee 	throw new ConsumerException(drop.getDefaultMessage(), drop);
55*fb3fb4f3Stomee     }
56*fb3fb4f3Stomee 
57*fb3fb4f3Stomee     /**
58*fb3fb4f3Stomee      * Terminates a running {@link Consumer} by throwing an exception.
59*fb3fb4f3Stomee      *
60*fb3fb4f3Stomee      * @throws ConsumerException
61*fb3fb4f3Stomee      */
62*fb3fb4f3Stomee     public void
errorEncountered(ErrorEvent e)63*fb3fb4f3Stomee     errorEncountered(ErrorEvent e) throws ConsumerException
64*fb3fb4f3Stomee     {
65*fb3fb4f3Stomee 	Error error = e.getError();
66*fb3fb4f3Stomee 	throw new ConsumerException(error.getDefaultMessage(), error);
67*fb3fb4f3Stomee     }
68*fb3fb4f3Stomee 
69*fb3fb4f3Stomee     /** Empty method */
processStateChanged(ProcessEvent e)70*fb3fb4f3Stomee     public void processStateChanged(ProcessEvent e) throws ConsumerException {}
71*fb3fb4f3Stomee     /** Empty method */
consumerStarted(ConsumerEvent e)72*fb3fb4f3Stomee     public void consumerStarted(ConsumerEvent e) {}
73*fb3fb4f3Stomee     /** Empty method */
consumerStopped(ConsumerEvent e)74*fb3fb4f3Stomee     public void consumerStopped(ConsumerEvent e) {}
75*fb3fb4f3Stomee     /** Empty method */
intervalBegan(ConsumerEvent e)76*fb3fb4f3Stomee     public void intervalBegan(ConsumerEvent e) {}
77*fb3fb4f3Stomee     /** Empty method */
intervalEnded(ConsumerEvent e)78*fb3fb4f3Stomee     public void intervalEnded(ConsumerEvent e) {}
79*fb3fb4f3Stomee }
80