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 /**
30 * @return the name of the current document.
31 */
32 String getName();
33
34 /**
35 * Reads the contents of this document.
36 * @return <code>Reader</code> not null
37 * @throws IOException if this document cannot be read
38 * @throws CompositeDocumentException if this document can only be read as
39 * a composite archive
40 */
41 Reader reader() throws IOException;
42
43 /**
44 * Streams the document's contents.
45 * @return not null
46 * @throws IOException when stream could not be opened
47 */
48 InputStream inputStream() throws IOException;
49
50 /**
51 * Gets data describing this resource.
52 * @return not null
53 */
54 MetaData getMetaData();
55
56 /**
57 * Is this a composite document?
58 * @return true if composite, false otherwise
59 */
60 boolean isComposite();
61 }