FinderFactory.WholeWordsFwdFinder (Editor Library) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.editor.lib/1 1.14.0 3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.netbeans.editor
Class FinderFactory.WholeWordsFwdFinder

java.lang.Object
  org.netbeans.editor.FinderFactory.AbstractFinder
      org.netbeans.editor.FinderFactory.GenericFwdFinder
          org.netbeans.editor.FinderFactory.WholeWordsFwdFinder

All Implemented Interfaces:: Finder, FinderFactory.StringFinder

Enclosing class:: FinderFactory

public static final class FinderFactory.WholeWordsFwdFinder
extends FinderFactory.GenericFwdFinder
implements FinderFactory.StringFinder
extends FinderFactory.GenericFwdFinder
implements FinderFactory.StringFinder

String forward finder that finds whole words only. There are some speed optimizations attempted.

Field Summary

Fields inherited from class org.netbeans.editor.FinderFactory.AbstractFinder

found

Constructor Summary

FinderFactory.WholeWordsFwdFinder(BaseDocument doc, String s, boolean matchCase)


Method Summary

int getFoundLength()
          Get the length of the found string.

void reset()
          Reset the finder

protected int scan(char ch, boolean lastChar)
          This function decides if it found a desired string or not.

Methods inherited from class org.netbeans.editor.FinderFactory.GenericFwdFinder

find

Methods inherited from class org.netbeans.editor.FinderFactory.AbstractFinder

isFound

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.netbeans.editor.Finder

find, isFound

Fields inherited from class org.netbeans.editor.FinderFactory.AbstractFinder
`found`

Constructor Summary
`FinderFactory.WholeWordsFwdFinder(BaseDocument doc, String s, boolean matchCase)`

Method Summary
`int`	`getFoundLength()` Get the length of the found string.
`void`	`reset()` Reset the finder
`protected int`	`scan(char ch, boolean lastChar)` This function decides if it found a desired string or not.

Methods inherited from class org.netbeans.editor.FinderFactory.GenericFwdFinder
`find`

Methods inherited from class org.netbeans.editor.FinderFactory.AbstractFinder
`isFound`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface org.netbeans.editor.Finder
`find, isFound`

Constructor Detail

FinderFactory.WholeWordsFwdFinder

public FinderFactory.WholeWordsFwdFinder(BaseDocument doc,
                                         String s,
                                         boolean matchCase)

Method Detail

getFoundLength

public int getFoundLength()

Description copied from interface: FinderFactory.StringFinder

Get the length of the found string. This is useful for regular expressions, because the length of the regular expression can be different than the length of the string that matched the expression.

Specified by:: getFoundLength in interface FinderFactory.StringFinder

reset

public void reset()

Description copied from class: FinderFactory.AbstractFinder

Reset the finder

Specified by:: reset in interface Finder
Overrides:: reset in class FinderFactory.AbstractFinder

scan

protected int scan(char ch,
                   boolean lastChar)

Description copied from class: FinderFactory.GenericFwdFinder

This function decides if it found a desired string or not. The function receives currently searched character and flag if it's the last one that is searched or not.

Specified by:: scan in class FinderFactory.GenericFwdFinder

Returns:: if the function decides that it found a desired string it sets found = true and returns how many characters back the searched string begins in forward direction (0 stands for current character). For example if the function looks for word 'yes' and it gets 's' as parameter it sets found = true and returns -2. If the string is not yet found it returns how many characters it should go in forward direction (in this case it would usually be 1). The next searched character will be that one requested.