gnu.java.util.regex

Class REMatchEnumeration

Implemented Interfaces:
, Enumeration<E>, Serializable

public class REMatchEnumeration
extends Object
implements Enumeration<E>, , Serializable

An REMatchEnumeration enumerates regular expression matches over a given input text. You obtain a reference to an enumeration using the getMatchEnumeration() methods on an instance of RE.

REMatchEnumeration does lazy computation; that is, it will not search for a match until it needs to. If you'd rather just get all the matches at once in a big array, use the getAllMatches() methods on RE. However, using an enumeration can help speed performance when the entire text does not need to be searched immediately.

The enumerated type is especially useful when searching on a Reader or InputStream, because the InputStream read position cannot be guaranteed after calling getMatch() (see the description of that method for an explanation of why). Enumeration also saves a lot of overhead required when calling getMatch() multiple times.

See Also:
Serialized Form

Method Summary

boolean
hasMoreElements()
Returns true if there are more matches in the input text.
boolean
hasMoreMatches()
Returns true if there are more matches in the input text.
boolean
hasMoreMatches(CPStringBuilder buffer)
Returns true if there are more matches in the input text.
REMatch
nextElement()
Returns the next match in the input text.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

hasMoreElements

public boolean hasMoreElements()
Returns true if there are more matches in the input text.
Specified by:
hasMoreElements in interface Enumeration<E>

hasMoreMatches

public boolean hasMoreMatches()
Returns true if there are more matches in the input text.

hasMoreMatches

public boolean hasMoreMatches(CPStringBuilder buffer)
Returns true if there are more matches in the input text. Saves the text leading up to the match (or to the end of the input) in the specified buffer.

nextElement

public REMatch nextElement()
            throws NoSuchElementException
Returns the next match in the input text.
Specified by:
nextElement in interface Enumeration<E>

gnu/regexp/REMatchEnumeration.java Copyright (C) 1998-2001, 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.