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
20 package org.apache.rat.walker;
21
22 import org.apache.rat.api.Document;
23 import org.apache.rat.document.DocumentName;
24 import org.apache.rat.report.IReportable;
25
26 /**
27 * Abstract walker.
28 */
29 public abstract class Walker implements IReportable {
30
31 /** The document this walker is walking */
32 private final Document document;
33
34 /**
35 * Creates the walker
36 * @param document The document the walker is walking.
37 */
38 protected Walker(final Document document) {
39 this.document = document;
40 }
41
42 /**
43 * Retrieves the document from the constructor.
44 * @return the document from the constructor.
45 */
46 protected Document getDocument() {
47 return document;
48 }
49
50 @Override
51 public DocumentName getName() {
52 return document.getName();
53 }
54 }