blob: 568e38c19b831390ffcdd909ea0621c8e727818e [file] [log] [blame]
Brian O'Connorcff03322015-02-03 15:28:59 -08001/*
2 * Copyright 2015 Open Networking Laboratory
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 */
16package org.onlab.util;
17
18import java.util.List;
19
20/**
Thomas Vachuskaecb63c52015-02-19 10:03:48 -080021 * Abstraction of an accumulator capable of collecting items and at some
22 * point in time triggers processing of all previously accumulated items.
23 *
24 * @param <T> item type
Brian O'Connorcff03322015-02-03 15:28:59 -080025 */
26public interface Accumulator<T> {
27
28 /**
Thomas Vachuskaecb63c52015-02-19 10:03:48 -080029 * Adds an item to the current batch. This operation may, or may not
30 * trigger processing of the current batch of items.
Brian O'Connorcff03322015-02-03 15:28:59 -080031 *
Thomas Vachuskaecb63c52015-02-19 10:03:48 -080032 * @param item item to be added to the current batch
Brian O'Connorcff03322015-02-03 15:28:59 -080033 */
Thomas Vachuskaecb63c52015-02-19 10:03:48 -080034 void add(T item);
Brian O'Connorcff03322015-02-03 15:28:59 -080035
36 /**
Thomas Vachuskaecb63c52015-02-19 10:03:48 -080037 * Processes the specified list of accumulated items.
Brian O'Connorcff03322015-02-03 15:28:59 -080038 *
Thomas Vachuskaecb63c52015-02-19 10:03:48 -080039 * @param items list of accumulated items
Brian O'Connorcff03322015-02-03 15:28:59 -080040 */
Thomas Vachuskaecb63c52015-02-19 10:03:48 -080041 void processItems(List<T> items);
Brian O'Connorcff03322015-02-03 15:28:59 -080042
Brian O'Connordb15b042015-02-04 14:59:28 -080043 //TODO consider a blocking version that required consumer participation
Thomas Vachuskaecb63c52015-02-19 10:03:48 -080044
Brian O'Connorcff03322015-02-03 15:28:59 -080045}