org.apache.rat.header

Class HeaderMatcher

java.lang.Object

org.apache.rat.header.HeaderMatcher

public class HeaderMatcher
extends Object

Matches headers.

Usage:

1. read(Reader) content
2. matches(Pattern) against filtered content

Note: use only from a single thread.

Constructor Summary

Constructors

Constructor and Description
HeaderMatcher(org.apache.rat.header.CharFilter filter, int capacity)
HeaderMatcher(org.apache.rat.header.CharFilter filter, int capacity, HeaderBean[] headers)

Method Summary

Modifier and Type	Method and Description
int	lines() Number of lines read.
boolean	matches(Pattern pattern) Seeks a match in the last headers read.
void	read(Reader reader)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HeaderMatcher

public HeaderMatcher(org.apache.rat.header.CharFilter filter,
                     int capacity)

HeaderMatcher

public HeaderMatcher(org.apache.rat.header.CharFilter filter,
                     int capacity,
                     HeaderBean[] headers)

Method Detail

read

public void read(Reader reader)
          throws IOException

Throws:

IOException

matches

public boolean matches(Pattern pattern)

Seeks a match in the last headers read.

Note that this pattern must not contain filtered characters.

Parameters:

pattern - Pattern to match

Returns:

true if the pattern matches, false otherwise or if read(Reader) has not been called

lines

public int lines()

Number of lines read.

Returns:

the number of lines in the file or -1 if the file has more lines than were read