org.apache.rat.analysis

Class HeaderCheckWorker

java.lang.Object

org.apache.rat.analysis.HeaderCheckWorker

class HeaderCheckWorker
extends java.lang.Object

Reads from a stream to check license.

Note that this class is not thread safe.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_NUMBER_OF_RETAINED_HEADER_LINES
private boolean	finished
private int	headerLinesToRead
private boolean	match
private IHeaderMatcher	matcher
private int	numberOfRetainedHeaderLines
private java.io.BufferedReader	reader
private Document	subject

Constructor Summary

Constructors

Constructor and Description
HeaderCheckWorker(java.io.BufferedReader reader, IHeaderMatcher matcher, Document name)
HeaderCheckWorker(java.io.BufferedReader reader, int numberOfRetainedHeaderLine, IHeaderMatcher matcher, Document name)
HeaderCheckWorker(java.io.Reader reader, IHeaderMatcher matcher, Document name) Convenience constructor wraps given Reader in a BufferedReader.

Method Summary

Modifier and Type	Method and Description
boolean	isFinished()
void	read()
(package private) boolean	readLine(java.lang.StringBuilder headers)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NUMBER_OF_RETAINED_HEADER_LINES

public static final int DEFAULT_NUMBER_OF_RETAINED_HEADER_LINES

See Also:

Constant Field Values

numberOfRetainedHeaderLines

private final int numberOfRetainedHeaderLines

reader

private final java.io.BufferedReader reader

matcher

private final IHeaderMatcher matcher

subject

private final Document subject

match

private boolean match

headerLinesToRead

private int headerLinesToRead

finished

private boolean finished

Constructor Detail

HeaderCheckWorker

public HeaderCheckWorker(java.io.Reader reader,
                         IHeaderMatcher matcher,
                         Document name)

Convenience constructor wraps given Reader in a BufferedReader.

Parameters:

reader - a Reader for the content, not null

name - the name of the checked content, possibly null

HeaderCheckWorker

public HeaderCheckWorker(java.io.BufferedReader reader,
                         IHeaderMatcher matcher,
                         Document name)

HeaderCheckWorker

public HeaderCheckWorker(java.io.BufferedReader reader,
                         int numberOfRetainedHeaderLine,
                         IHeaderMatcher matcher,
                         Document name)

Method Detail

isFinished

public boolean isFinished()

read

public void read()
          throws RatHeaderAnalysisException

Throws:

RatHeaderAnalysisException

readLine

boolean readLine(java.lang.StringBuilder headers)
          throws java.io.IOException,
                 RatHeaderAnalysisException

Throws:

java.io.IOException

RatHeaderAnalysisException