bindings/java/org/collectd/api/CollectdMatchFactoryInterface.java

   1 /*
   2  * collectd/java - org/collectd/api/CollectdMatchFactoryInterface.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 factory".
  26  *
  27  * Objects implementing this interface are used to create objects implementing
  28  * the CollectdMatchInterface interface.
  29  *
  30  * @author Florian Forster &lt;octo at verplant.org&gt;
  31  * @see CollectdMatchInterface
  32  * @see Collectd#registerMatch
  33  */
  34 public interface CollectdMatchFactoryInterface
  35 {
  36         /**
  37          * Create a new "match" object.
  38          *
  39          * This method uses the configuration provided as argument to create a
  40          * new object which must implement the {@link CollectdMatchInterface}
  41          * interface.
  42          *
  43          * This function corresponds to the <code>create</code> member of the
  44          * <code>src/filter_chain.h:match_proc_t</code> struct.
  45          *
  46          * @return New {@link CollectdMatchInterface} object.
  47          */
  48         public CollectdMatchInterface createMatch (OConfigItem ci);
  49 }