All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.oroinc.text.regex.Perl5StreamInput 

java.lang.Object
   |
   +----com.oroinc.text.regex.Perl5StreamInput
public final class Perl5StreamInput
extends Object
The Perl5StreamInput class is used to look for pattern matches in an InputStream in conjunction with the Perl5Matcher class. It is called Perl5StreamInput instead of Perl5InputStream to stress that it is a form of streamed input for the Perl5Matcher rather than a subclass of InputStream. Perl5StreamInput performs special internal buffering to accelerate pattern searches through a stream. You can determine the size of this buffer and how it grows by using the appropriate constructor. You should avoid using buffer increments smaller than 4096 bytes, as they will adversely affect peformance.

If you want to perform line by line matches on an InputStream, you should use DataInputStream or BufferedReader class (depending on whether you are using JDK 1.0.2 or 1.1) in conjunction with one of the PatternMatcher methods taking a String, char[], or PatternMatcherInput as an argument. The DataInputStream and BufferedReader readLine() methods are implemented as native methods and therefore more efficient than supporting line by line searching within Perl5StreamInput.

In the future the programmer will be able to set this class to save all the input it sees so that it can be accessed later. This will avoid having to read a stream more than once for whatever reason.

Copyright © 1997 Original Resuable Objects, Inc. All rights reserved.

Author:
Daniel F. Savarese
See Also:
Perl5Matcher

Constructor Index

o Perl5StreamInput(InputStream)
Creates a Perl5StreamInput instance bound to an InputStream with an initial buffer size and default buffer increment of 4096 bytes.
o Perl5StreamInput(InputStream, int)
Creates a Perl5StreamInput instance bound to an InputStream with a specified initial buffer size and default buffer increment.

Method Index

o endOfStream()

Constructors

o Perl5StreamInput 
 public Perl5StreamInput(InputStream input,
                         int bufferIncrement)
Creates a Perl5StreamInput instance bound to an InputStream with a specified initial buffer size and default buffer increment.

Parameters:
input - The InputStream to associate with the Perl5StreamInput instance.
bufferIncrement - The initial buffer size and the default buffer increment to use when the input buffer has to be increased in size.
o Perl5StreamInput 
 public Perl5StreamInput(InputStream input)
Creates a Perl5StreamInput instance bound to an InputStream with an initial buffer size and default buffer increment of 4096 bytes.

Parameters:
input - The InputStream to associate with the Perl5StreamInput instance.

Methods

o endOfStream 
 public boolean endOfStream()

All Packages  Class Hierarchy  This Package  Previous  Next  Index