Package org.htmlparser.filters
Class StringFilter
java.lang.Object
org.htmlparser.filters.StringFilter
- All Implemented Interfaces:
Serializable
,Cloneable
,NodeFilter
This class accepts all string nodes containing the given string.
This is a fairly simplistic filter, so for more sophisticated
string matching, for example newline and whitespace handling,
use a
RegexFilter
instead.- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionCreates a new instance of StringFilter that accepts all string nodes.StringFilter
(String pattern) Creates a StringFilter that accepts text nodes containing a string.StringFilter
(String pattern, boolean sensitive) Creates a StringFilter that accepts text nodes containing a string.StringFilter
(String pattern, boolean sensitive, Locale locale) Creates a StringFilter that accepts text nodes containing a string. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Accept string nodes that contain the string.boolean
Get the case sensitivity.Get the locale for uppercase conversion.Get the search pattern.void
setCaseSensitive
(boolean sensitive) Set case sensitivity on or off.void
Set the locale for uppercase conversion.void
setPattern
(String pattern) Set the search pattern.protected void
Set the real (upper case) comparison string.
-
Field Details
-
mPattern
The string to search for. -
mUpperPattern
The string to really search for (converted to uppercase if necessary). -
mCaseSensitive
protected boolean mCaseSensitiveCase sensitive toggle. Iftrue
strings are compared with case sensitivity. -
mLocale
The locale to use converting to uppercase in case insensitive searches.
-
-
Constructor Details
-
StringFilter
public StringFilter()Creates a new instance of StringFilter that accepts all string nodes. -
StringFilter
Creates a StringFilter that accepts text nodes containing a string. The comparison is case insensitive, with conversions done using the defaultLocale
.- Parameters:
pattern
- The pattern to search for.
-
StringFilter
Creates a StringFilter that accepts text nodes containing a string.- Parameters:
pattern
- The pattern to search for.sensitive
- Iftrue
, comparisons are performed respecting case, with conversions done using the defaultLocale
.
-
StringFilter
Creates a StringFilter that accepts text nodes containing a string.- Parameters:
pattern
- The pattern to search for.sensitive
- Iftrue
, comparisons are performed respecting case.locale
- The locale to use when converting to uppercase. Ifnull
, the defaultLocale
is used.
-
-
Method Details
-
setUpperPattern
protected void setUpperPattern()Set the real (upper case) comparison string. -
getCaseSensitive
public boolean getCaseSensitive()Get the case sensitivity.- Returns:
- Returns the case sensitivity.
-
setCaseSensitive
public void setCaseSensitive(boolean sensitive) Set case sensitivity on or off.- Parameters:
sensitive
- Iffalse
searches for the string are case insensitive.
-
getLocale
Get the locale for uppercase conversion.- Returns:
- Returns the locale.
-
setLocale
Set the locale for uppercase conversion.- Parameters:
locale
- The locale to set.
-
getPattern
Get the search pattern.- Returns:
- Returns the pattern.
-
setPattern
Set the search pattern.- Parameters:
pattern
- The pattern to set.
-
accept
Accept string nodes that contain the string.- Specified by:
accept
in interfaceNodeFilter
- Parameters:
node
- The node to check.- Returns:
true
ifnode
is aText
node and contains the pattern string,false
otherwise.
-