##### Coverage Report - org.apache.any23.source.DocumentSource

Classes in this File | Line Coverage | Branch Coverage | Complexity
DocumentSource |
N/A | N/A
N/A | N/A
| 1.0;1

1 |  |
     /*
2 |  |
      * Licensed to the Apache Software Foundation (ASF) under one or more
3 |  |
      * contributor license agreements.  See the NOTICE file distributed with
4 |  |
      * this work for additional information regarding copyright ownership.
5 |  |
      * The ASF licenses this file to You under the Apache License, Version 2.0
6 |  |
      * (the "License"); you may not use this file except in compliance with
7 |  |
      * the License.  You may obtain a copy of the License at
8 |  |
      *
9 |  |
      *  http://www.apache.org/licenses/LICENSE-2.0
10 |  |
      *
11 |  |
      * Unless required by applicable law or agreed to in writing, software
12 |  |
      * distributed under the License is distributed on an "AS IS" BASIS,
13 |  |
      * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 |  |
      * See the License for the specific language governing permissions and
15 |  |
      * limitations under the License.
16 |  |
      */
17 |  |
18 |  |
     package org.apache.any23.source;
19 |  |
20 |  |
     import java.io.IOException;
21 |  |
     import java.io.InputStream;
22 |  |
23 |  |
     /**
24 |  |
      * A source of input streams. Mostly intended for
25 |  |
      * situations where opening of an input stream is
26 |  |
      * to be delayed.
27 |  |
      *
28 |  |
      * @author Richard Cyganiak (richard@cyganiak.de)
29 |  |
      */
30 |  |
     public interface DocumentSource {
31 |  |
32 |  |
         /**
33 |  |
          * Returns the input stream for accessing the content of the document.
34 |  |
          *
35 |  |
          * @return not <code>null</code> input stream for accessing document data.
36 |  |
          * @throws IOException
37 |  |
          */
38 |  |
         InputStream openInputStream() throws IOException;
39 |  |
40 |  |
         /**
41 |  |
          * @return a string describing the content type of the provided document.
42 |  |
          */
43 |  |
         public String getContentType();
44 |  |
45 |  |
         /**
46 |  |
          * @return the size of the content length in bytes.
47 |  |
          */
48 |  |
         public long getContentLength();
49 |  |
50 |  |
         /**
51 |  |
          * @return the actual, final, canonical URI if redirects occur.
52 |  |
          */
53 |  |
         public String getDocumentURI();
54 |  |
55 |  |
         /**
56 |  |
          * A value of <tt>false</tt> indicates that the document
57 |  |
          * resides remotely, and that multiple successive accesses
58 |  |
          * to it should be avoided by copying it to local storage.
59 |  |
          * This can also be used for sources that do not support
60 |  |
          * multiple calls to {@link #openInputStream()}.
61 |  |
          */
62 |  |
         public boolean isLocal();
63 |  |
     }