1 /**
2 * collectd - bindings/java/org/collectd/api/CollectdMatchInterface.java
3 * Copyright (C) 2009 Florian octo Forster
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
22 *
23 * Authors:
24 * Florian octo Forster <octo at collectd.org>
25 */
27 package org.collectd.api;
29 /**
30 * Interface for objects implementing a match method.
31 *
32 * These objects are instantiated using objects which implement the
33 * CollectdMatchFactoryInterface interface. They are not instantiated by the
34 * daemon directly!
35 *
36 * @author Florian Forster <octo at collectd.org>
37 * @see CollectdMatchFactoryInterface
38 * @see Collectd#registerMatch
39 */
40 public interface CollectdMatchInterface
41 {
42 /**
43 * Callback method for matches.
44 *
45 * This method is called to decide whether or not a given ValueList
46 * matches or not. How this is determined is the is the main part of
47 * this function.
48 *
49 * @return One of {@link Collectd#FC_MATCH_NO_MATCH} and {@link Collectd#FC_MATCH_MATCHES}.
50 * @see CollectdMatchFactoryInterface
51 */
52 public int match (DataSet ds, ValueList vl);
53 } /* public interface CollectdMatchInterface */