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;
20
21 import java.io.ByteArrayInputStream;
22 import java.io.File;
23 import java.io.IOException;
24 import java.io.InputStream;
25 import java.util.Collections;
26 import java.util.SortedSet;
27
28 import org.apache.rat.api.Document;
29
30 /**
31 * Document wrapping a File object that is ignored by rule.
32 */
33 public class IgnoredDocument extends Document {
34
35 /**
36 * Creates a File document.
37 * @param basedir the base directory for this document.
38 * @param file the file to wrap.
39 * @param nameMatcher the path matcher to filter files/directories with.
40 */
41 public IgnoredDocument(final DocumentName basedir, final File file, final DocumentNameMatcher nameMatcher) {
42 super(DocumentName.builder(file).setBaseName(basedir.getBaseName()).build(), nameMatcher);
43 this.getMetaData().setDocumentType(Type.IGNORED);
44 this.getMetaData().setIsDirectory(file.isDirectory());
45 }
46
47 @Override
48 public boolean isDirectory() {
49 return getMetaData().isDirectory();
50 }
51
52 @Override
53 public SortedSet<Document> listChildren() {
54 return Collections.emptySortedSet();
55 }
56
57 @Override
58 public InputStream inputStream() throws IOException {
59 return new ByteArrayInputStream(new byte[0]);
60 }
61 }