KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > dream > aggregator > PullPullAggregatorWhileNotNullAttributeController


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.aggregator;
26
27 import org.objectweb.fractal.api.control.AttributeController;
28
29 /**
30  * Attribute controller interface for
31  * {@link PullPullAggregatorWhileNotNullImpl }aggregator implementation.
32  * Defines the behavior when the first pulled message is null.
33  */
34 public interface PullPullAggregatorWhileNotNullAttributeController
35     extends
36       AttributeController
37 {
38   /**
39    * Returns <code>true</code> if the aggregator must return an empty message
40    * when no message can't be aggregated. If <code>false</code>, the
41    * aggregator returns <code>null</code>.
42    *
43    * @return the current <code>pullEmptyMessage</code> policy.
44    */
45   boolean getPullEmptyMessagePolicy();
46
47   /**
48    * Sets the <code>pullEmptyMessage</code> policy.
49    *
50    * @param policy the new <code>pullEmptyMessage</code> policy.
51    * @see #getPullEmptyMessagePolicy()
52    */
53   void setPullEmptyMessagePolicy(boolean policy);
54 }
Popular Tags