|
Server : Apache/2.2.2 (Fedora) System : Linux App1.pathumtani.go.th 2.6.20-1.2320.fc5smp #1 SMP Tue Jun 12 19:40:16 EDT 2007 i686 User : apache ( 48) PHP Version : 5.2.9 Disable Function : NONE Directory : /usr/share/javadoc/regexp/org/apache/regexp/ |
Upload File : |
<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE html PUBLIC "-//gnu.org///DTD XHTML 1.1 plus Target 1.0//EN" "../../../resources/xhtml11-target10.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><title>REProgram (Jakarta-Regexp 1.3 API)</title><script src="../../../resources/gjdoc.js" type="text/javascript"><!-- this comment required for konqueror 3.2.2 --></script><meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"/><meta name="generator" content="GNU Gjdoc Standard Doclet"/><meta name="keywords" content="org.apache.regexp.REProgram class"/><meta name="keywords" content="OPT_HASBACKREFS"/><meta name="keywords" content="instruction"/><meta name="keywords" content="lenInstruction"/><meta name="keywords" content="prefix"/><meta name="keywords" content="flags"/><meta name="keywords" content="maxParens"/><meta name="keywords" content="getInstructions()"/><meta name="keywords" content="setInstructions()"/><link rel="stylesheet" type="text/css" href="../../../resources/gjdochtml-clean-layout.css" title="GNU Clean"/><link rel="stylesheet" type="text/css" href="../../../resources/gjdochtml-clean-color1.css" title="GNU Clean"/></head><body class="content class" onload="if(parent.contentPageLoaded)parent.contentPageLoaded(document.title)"><table class="navbar div top"><tr><td class="navbar div top"><div class="navbar div top"><span class="navbar item enabled"><a href="../../../overview-summary.html">Overview</a></span> <span class="navbar item enabled"><a href="package-summary.html">Package</a></span> <span class="navbar item active">Class</span> <span class="navbar item enabled"><a href="REProgram-uses.html">Use</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../../../alphaindex.html">Index</a></span> <span class="navbar item enabled"><a href="../../../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../../../about.html">About</a></span></div></td></tr><tr><td class="navi"><a href="../../../org/apache/regexp/REDemo.html">Prev Class</a> | <a href="../../../org/apache/regexp/RESyntaxException.html">Next Class</a></td><td class="navi"><a href="../../../index.html" title="Show in a frameset" target="_top">Frames</a> | <a href="REProgram.html" title="Show without frames" target="_top">No Frames</a> </td></tr><tr><td class="navi">Summary: Nested | <a href="#summary-fields">Field</a> | <a href="#summary-methods">Method</a> | <a href="#summary-constructors">Constr</a></td><td class="navi">Detail: Nested | <a href="#detail-fields">Field</a> | <a href="#detail-methods">Method</a> | <a href="#detail-constructors">Constr</a></td></tr></table><div class="class title outer"><h3 class="class title-package">org.apache.regexp</h3><h1 class="class title-class">Class REProgram</h1></div><div class="class inheritance-tree"><ul class="inheritance 0"><li class="inheritance 0"><code>java.lang.Object</code></li><li><ul class="inheritance 1"><li class="inheritance 1"><code>org.apache.regexp.REProgram</code></li><li></li></ul></li></ul></div><dl class="class knownimplementing"><dt class="header"><b>Implemented Interfaces:</b></dt><dd class="item">Serializable</dd></dl><hr/><div class="class synopsis outer"><div class="class synopsis declaration"><code>public class <b class="class synopsis name">REProgram</b></code></div><div class="class synopsis superclass"><code>extends java.lang.Object</code></div><div class="class synopsis implements"><code>implements Serializable</code></div></div><hr/><div class="class description"> A class that holds compiled regular expressions. This is exposed mainly
for use by the recompile utility (which helps you produce precompiled
REProgram objects). You should not otherwise need to work directly with
this class.
</div><div class="taglet"><dl class="tag list"></dl><dt class="tag section header"><b>Version:</b></dt><dd>$Id: REProgram.java,v 1.3 2003/05/02 01:03:47 vgritsenko Exp $</dd></dl></div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>Author:</b></dt><dd class="tag item"><a href="mailto:jonl@muppetlabs.com">Jonathan Locke</a></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>See Also:</b></dt><dd><a href="../../../org/apache/regexp/RE.html"><code>RE</code></a>, <a href="../../../org/apache/regexp/RECompiler.html"><code>RECompiler</code></a></dd></dl></div><div class="taglet"></div><div class="taglet"></div><a name="summary-fields" id="summary-fields"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Field Summary</h2></td></tr><tr><td class="left" valign="top"><code class="synopsis">(package private) static int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#OPT_HASBACKREFS">OPT_HASBACKREFS</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">(package private) int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#flags">flags</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">(package private) char[]</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#instruction">instruction</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">(package private) int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#lenInstruction">lenInstruction</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">(package private) int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#maxParens">maxParens</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">(package private) char[]</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#prefix">prefix</a></code></dt></dl></td></tr></table></dd></dl><a name="summary-constructors" id="summary-constructors"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Constructor Summary</h2></td></tr><tr><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#REProgram(char[])">REProgram</a>(char[] instruction)</code></dt><dd class="description"> Constructs a program object from a character array
</dd></dl></td></tr><tr><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#REProgram(char[],int)">REProgram</a>(char[] instruction, int lenInstruction)</code></dt><dd class="description"> Constructs a program object from a character array
</dd></dl></td></tr><tr><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#REProgram(int,char[])">REProgram</a>(int parens, char[] instruction)</code></dt><dd class="description"> Constructs a program object from a character array
</dd></dl></td></tr></table></dd></dl><a name="summary-methods" id="summary-methods"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Method Summary</h2></td></tr><tr><td class="left" valign="top"><code class="synopsis"> char[]</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getInstructions()">getInstructions</a>()</code></dt><dd class="description"> Returns a copy of the current regular expression program in a character
array that is exactly the right length to hold the program.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#setInstructions(char[],int)">setInstructions</a>(char[] instruction, int lenInstruction)</code></dt><dd class="description"> Sets a new regular expression program to run.</dd></dl></td></tr></table></dd></dl><a name="detail-fields" id="detail-fields"/><h2 class="section header">Field Details</h2><div class="section"><a name="OPT_HASBACKREFS" id="OPT_HASBACKREFS"/><div class="member detail outer"><h3 class="member detail name">OPT_HASBACKREFS</h3><pre class="member detail synopsis">(package private) static final int OPT_HASBACKREFS</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="member detail thrown list"><dl><dt class="member detail thrown header"><b>Field Value:</b></dt><dd class="member detail thrown item">1</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="flags" id="flags"/><div class="member detail outer"><h3 class="member detail name">flags</h3><pre class="member detail synopsis">(package private) int flags</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="instruction" id="instruction"/><div class="member detail outer"><h3 class="member detail name">instruction</h3><pre class="member detail synopsis">(package private) char[] instruction</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="lenInstruction" id="lenInstruction"/><div class="member detail outer"><h3 class="member detail name">lenInstruction</h3><pre class="member detail synopsis">(package private) int lenInstruction</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="maxParens" id="maxParens"/><div class="member detail outer"><h3 class="member detail name">maxParens</h3><pre class="member detail synopsis">(package private) int maxParens</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="prefix" id="prefix"/><div class="member detail outer"><h3 class="member detail name">prefix</h3><pre class="member detail synopsis">(package private) char[] prefix</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><a name="detail-constructors" id="detail-constructors"/><h2 class="section header">Constructor Details</h2><div class="section"><a name="REProgram(char[])" id="REProgram(char[])"/><div class="member detail outer"><h3 class="member detail name">REProgram</h3><pre class="member detail synopsis">public REProgram(char[] instruction)</pre><blockquote class="member detail name"><div class="member detail description"> Constructs a program object from a character array
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">instruction</code><span class="separator"> - </span><span class="description">Character array with RE opcode instructions in it</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="REProgram(char[],int)" id="REProgram(char[],int)"/><div class="member detail outer"><h3 class="member detail name">REProgram</h3><pre class="member detail synopsis">public REProgram(char[] instruction,
int lenInstruction)</pre><blockquote class="member detail name"><div class="member detail description"> Constructs a program object from a character array
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">instruction</code><span class="separator"> - </span><span class="description">Character array with RE opcode instructions in it</span></dd><dd class="item"><code class="name">lenInstruction</code><span class="separator"> - </span><span class="description">Amount of instruction array in use</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="REProgram(int,char[])" id="REProgram(int,char[])"/><div class="member detail outer"><h3 class="member detail name">REProgram</h3><pre class="member detail synopsis">public REProgram(int parens,
char[] instruction)</pre><blockquote class="member detail name"><div class="member detail description"> Constructs a program object from a character array
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">parens</code><span class="separator"> - </span><span class="description">Count of parens in the program</span></dd><dd class="item"><code class="name">instruction</code><span class="separator"> - </span><span class="description">Character array with RE opcode instructions in it</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><a name="detail-methods" id="detail-methods"/><h2 class="section header">Method Details</h2><div class="section"><a name="getInstructions()" id="getInstructions()"/><div class="member detail outer"><h3 class="member detail name">getInstructions</h3><pre class="member detail synopsis">public char[] getInstructions()</pre><blockquote class="member detail name"><div class="member detail description"> Returns a copy of the current regular expression program in a character
array that is exactly the right length to hold the program. If there is
no program compiled yet, getInstructions() will return null.
</div><div class="member detail return list"><dl><dt class="member detail return header"><b>Returns:</b></dt><dd class="member detail return item">A copy of the current compiled RE program</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="setInstructions(char[],int)" id="setInstructions(char[],int)"/><div class="member detail outer"><h3 class="member detail name">setInstructions</h3><pre class="member detail synopsis">public void setInstructions(char[] instruction,
int lenInstruction)</pre><blockquote class="member detail name"><div class="member detail description"> Sets a new regular expression program to run. It is this method which
performs any special compile-time search optimizations. Currently only
two optimizations are in place - one which checks for backreferences
(so that they can be lazily allocated) and another which attempts to
find an prefix anchor string so that substantial amounts of input can
potentially be skipped without running the actual program.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">instruction</code><span class="separator"> - </span><span class="description">Program instruction buffer</span></dd><dd class="item"><code class="name">lenInstruction</code><span class="separator"> - </span><span class="description">Length of instruction buffer in use</span></dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><p class="navbar bottom spacer"> </p><table class="navbar div bottom"><tr><td><div class="navbar div top"><span class="navbar item enabled"><a href="../../../overview-summary.html">Overview</a></span> <span class="navbar item enabled"><a href="package-summary.html">Package</a></span> <span class="navbar item active">Class</span> <span class="navbar item enabled"><a href="REProgram-uses.html">Use</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../../../alphaindex.html">Index</a></span> <span class="navbar item enabled"><a href="../../../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../../../about.html">About</a></span></div></td></tr></table><hr/>Copyright © 2001-2003 Apache Software Foundation. All Rights Reserved.</body></html>