1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package org.xwiki.filter.input

File InputSource.java

 

Code metrics

0
0
0
1
42
6
0
-
-
0
-

Classes

Class Line # Actions
InputSource 35 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.filter.input;
21   
22    import java.io.Closeable;
23   
24    /**
25    * Represent a source of data used by a filter input stream. What kind of {@link InputSource} is supported by each input
26    * stream is entirely input stream choice.
27    * <p>
28    * {@link #close()} is only closing {@link Closeable} created by the {@link InputSource} itself. For example
29    * {@link DefaultInputStreamInputSource} is not going to close the {@link java.io.InputStream} passed to its constructor
30    * because it did not created it.
31    *
32    * @version $Id: d4fc0a3d47322276534d8f5373fa6a15ad9b81bc $
33    * @since 6.2M1
34    */
 
35    public interface InputSource extends Closeable
36    {
37    /**
38    * @return true if it's possible to close and reset the source to its beginning
39    * @since 6.2M1
40    */
41    boolean restartSupported();
42    }