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.document.impl;
20
21 import java.io.File;
22 import java.io.FileInputStream;
23 import java.io.FileReader;
24 import java.io.IOException;
25 import java.io.InputStream;
26 import java.io.Reader;
27
28 import org.apache.rat.api.Document;
29 import org.apache.rat.api.MetaData;
30
31 /**
32 * Document wrapping a file of undetermined composition.
33 *
34 */
35 public class FileDocument implements Document {
36
37 private final File file;
38 private final String name;
39 private final MetaData metaData = new MetaData();
40
41 public FileDocument(final File file) {
42 super();
43 this.file = file;
44 name = DocumentImplUtils.toName(file);
45 }
46
47 public boolean isComposite() {
48 return DocumentImplUtils.isZip(file);
49 }
50
51 public Reader reader() throws IOException {
52 return new FileReader(file);
53 }
54
55 public String getName() {
56 return name;
57 }
58
59 public MetaData getMetaData() {
60 return metaData;
61 }
62
63 public InputStream inputStream() throws IOException {
64 return new FileInputStream(file);
65 }
66
67 /**
68 * Representations suitable for logging.
69 * @return a <code>String</code> representation
70 * of this object.
71 */
72 @Override
73 public String toString()
74 {
75 return "FileDocument ( "
76 + "file = " + this.file + " "
77 + "name = " + this.name + " "
78 + "metaData = " + this.metaData + " "
79 + " )";
80 }
81
82
83 }