2 * collectd - bindings/java/org/collectd/api/CollectdTargetInterface.java
3 * Copyright (C) 2009 Florian octo Forster
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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.
24 * Florian octo Forster <octo at collectd.org>
27 package org.collectd.api;
30 * Interface for objects implementing a target method.
32 * These objects are instantiated using objects which implement the
33 * CollectdTargetFactoryInterface interface. They are not instantiated by the
36 * @author Florian Forster <octo at collectd.org>
37 * @see CollectdTargetFactoryInterface
38 * @see Collectd#registerTarget
40 public interface CollectdTargetInterface
43 * Callback method for targets.
45 * This method is called to perform some action on the given ValueList.
46 * What precisely is done depends entirely on the implementing class.
48 * @return One of: {@link Collectd#FC_TARGET_CONTINUE},
49 * {@link Collectd#FC_TARGET_STOP}, {@link Collectd#FC_TARGET_RETURN}
50 * @see CollectdTargetFactoryInterface
52 public int invoke (DataSet ds, ValueList vl);
53 } /* public interface CollectdTargetInterface */