View Javadoc
1   /*
2    * #%L
3    * wcm.io
4    * %%
5    * Copyright (C) 2014 wcm.io
6    * %%
7    * Licensed under the Apache License, Version 2.0 (the "License");
8    * you may not use this file except in compliance with the License.
9    * You may obtain a copy of the License at
10   *
11   *      http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   * #L%
19   */
20  package io.wcm.caravan.io.jsontransform.sink;
21  
22  import java.io.Closeable;
23  import java.io.IOException;
24  
25  import org.osgi.annotation.versioning.ConsumerType;
26  
27  import io.wcm.caravan.io.jsontransform.element.JsonElement;
28  
29  /**
30   * Sinks represent the end of a pipeline and consumes the data flow.
31   */
32  @ConsumerType
33  public interface Sink extends Closeable {
34  
35    /**
36     * Takes an JSON element and writes it some where in any format.
37     * @param jsonElement JSON element
38     * @throws IOException Writing error
39     */
40    void write(JsonElement jsonElement) throws IOException;
41  
42    /**
43     * @return True if any output was written
44     */
45    boolean hasOutput();
46  
47  }