1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one *
3 * or more contributor license agreements. See the NOTICE file *
4 * distributed with this work for additional information *
5 * regarding copyright ownership. The ASF licenses this file *
6 * to you under the Apache License, Version 2.0 (the *
7 * "License"); you may not use this file except in compliance *
8 * with the License. You may obtain a copy of the License at *
9 * *
10 * http://www.apache.org/licenses/LICENSE-2.0 *
11 * *
12 * Unless required by applicable law or agreed to in writing, *
13 * software distributed under the License is distributed on an *
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY *
15 * KIND, either express or implied. See the License for the *
16 * specific language governing permissions and limitations *
17 * under the License. *
18 */
19 package org.apache.rat.api;
20
21 import java.io.IOException;
22 import java.io.InputStream;
23 import java.io.Reader;
24
25 import org.apache.rat.document.CompositeDocumentException;
26
27 public interface Document {
28
29 String getName();
30
31 /**
32 * Reads the content of this document.
33 * @return <code>Reader</code> not null
34 * @throws IOException if this document cannot be read
35 * @throws CompositeDocumentException if this document can only be read as
36 * a composite archive
37 */
38 Reader reader() throws IOException;
39
40 /**
41 * Streams the document's contents.
42 * @return not null
43 * @throws IOException when stream could not be opened
44 */
45 InputStream inputStream() throws IOException;
46
47 /**
48 * Gets data describing this resource.
49 * @return not null
50 */
51 MetaData getMetaData();
52
53 /**
54 * Is this a composite document?
55 * @return true if composite, false otherwise
56 */
57 boolean isComposite();
58 }