View Javadoc
1   package org.apache.rat.analysis;
2   /*
3    * Licensed to the Apache Software Foundation (ASF) under one   *
4    * or more contributor license agreements.  See the NOTICE file *
5    * distributed with this work for additional information        *
6    * regarding copyright ownership.  The ASF licenses this file   *
7    * to you under the Apache License, Version 2.0 (the            *
8    * "License"); you may not use this file except in compliance   *
9    * with the License.  You may obtain a copy of the License at   *
10   *                                                              *
11   *   http://www.apache.org/licenses/LICENSE-2.0                 *
12   *                                                              *
13   * Unless required by applicable law or agreed to in writing,   *
14   * software distributed under the License is distributed on an  *
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
16   * KIND, either express or implied.  See the License for the    *
17   * specific language governing permissions and limitations      *
18   * under the License.                                           *
19   */
20  
21  /**
22   * The processed headers from a file.
23   */
24  public interface IHeaders {
25      /**
26       * Gets raw header as found in the document. 
27       * @return the raw header as read from the file.
28       */
29      public String raw();
30  
31      /**
32       * Gets the pruned header.  This is the header with all non letter 
33       * and non number characters removed and the string converted to lower case.
34       * @return The pruned header.
35       */
36      public String pruned();
37  
38  }