cc8a99e6e0f7aeb1173381711e4bd0b4c5281895
[collectd.git] / bindings / java / org / collectd / api / CollectdMatchInterface.java
1 /*
2  * collectd/java - org/collectd/api/CollectdMatchInterface.java
3  * Copyright (C) 2009  Florian octo Forster
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License as published by the
7  * Free Software Foundation; only version 2 of the License is applicable.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License along
15  * with this program; if not, write to the Free Software Foundation, Inc.,
16  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
17  *
18  * Authors:
19  *   Florian octo Forster <octo at verplant.org>
20  */
21
22 package org.collectd.api;
23
24 /**
25  * Interface for objects implementing a match method.
26  *
27  * These objects are instantiated using objects which implement the
28  * CollectdMatchFactoryInterface interface. They are not instantiated by the
29  * daemon directly!
30  *
31  * @author Florian Forster &lt;octo at verplant.org&gt;
32  * @see CollectdMatchFactoryInterface
33  * @see Collectd#registerMatch
34  */
35 public interface CollectdMatchInterface
36 {
37         /**
38          * Callback method for matches.
39          *
40          * This method is called to decide whether or not a given ValueList
41          * matches or not. How this is determined is the is the main part of
42          * this function.
43          *
44          * @return One of {@link Collectd#FC_MATCH_NO_MATCH} and {@link Collectd#FC_MATCH_MATCHES}.
45          * @see CollectdMatchFactoryInterface
46          */
47         public int match (DataSet ds, ValueList vl);
48 } /* public interface CollectdMatchInterface */