Merge branch 'collectd-5.4' into collectd-5.5
[collectd.git] / bindings / java / org / collectd / api / CollectdTargetFactoryInterface.java
1 /**
2  * collectd - bindings/java/org/collectd/api/CollectdTargetFactoryInterface.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  */
26
27 package org.collectd.api;
28
29 /**
30  * Interface for objects implementing a "target factory".
31  *
32  * Objects implementing this interface are used to create objects implementing
33  * the CollectdTargetInterface interface.
34  *
35  * @author Florian Forster &lt;octo at collectd.org&gt;
36  * @see CollectdTargetInterface
37  * @see Collectd#registerTarget
38  */
39 public interface CollectdTargetFactoryInterface
40 {
41         /**
42          * Create a new "target" object.
43          *
44          * This method uses the configuration provided as argument to create a
45          * new object which must implement the {@link CollectdTargetInterface}
46          * interface.
47          *
48          * This function corresponds to the {@code create} member of the
49          * {@code src/filter_chain.h:target_proc_t} struct.
50          *
51          * @return New {@link CollectdTargetInterface} object.
52          */
53         public CollectdTargetInterface createTarget (OConfigItem ci);
54 }