KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > dream > pump > PumpAttributeController


1 /**
2  * Dream
3  * Copyright (C) 2003-2004 INRIA Rhone-Alpes
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  * Contact: dream@objectweb.org
20  *
21  * Initial developer(s): Matthieu Leclercq
22  * Contributor(s):
23  */
24
25 package org.objectweb.dream.pump;
26
27 import org.objectweb.dream.control.activity.ActiveComponentAttributeController;
28
29 /**
30  * Attribute controller for pump components. If the <code>PushNullPolicy</code>
31  * is set to <code>true</code>, then if the message returned by the pull
32  * invocation is <code>null</code>, it is pushed. otherwise <code>null</code>
33  * is not pushed and another message is pulled. The default value is
34  * <code>false</code>.
35  */
36 public interface PumpAttributeController
37     extends
38       ActiveComponentAttributeController
39 {
40
41   /**
42    * Returns the PushNullPolicy.
43    *
44    * @return the PushNullPolicy.
45    */
46   boolean getPushNullPolicy();
47
48   /**
49    * Sets the PushNullPolicy.
50    *
51    * @param pushNull the PushNullPolicy.
52    */
53   void setPushNullPolicy(boolean pushNull);
54 }
Popular Tags