org.netbeans.api.search

Class SearchPattern

java.lang.Object

org.netbeans.api.search.SearchPattern

public final class SearchPattern
extends Object

Pattern describes the search conditions

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchPattern.MatchType Specifies how the pattern is matched to the searched text.

Method Summary

Modifier and Type	Method and Description
SearchPattern	changeMatchCase(boolean matchCase) Create new instance with "match case" set to passed value, and other values copied from this instance.
SearchPattern	changeMatchType(SearchPattern.MatchType matchType) Create new instance with "match type" set to passed value, and other values copied from this instance.
SearchPattern	changeRegExp(boolean regExp) Create new instance with "regular expression" set to passed value, and other values copied from this instance.
SearchPattern	changeSearchExpression(String expression) Create new instance with "search expression" set to passed value, and other values copied from this instance.
SearchPattern	changeWholeWords(boolean wholeWords) Create new instance with "whole words" set to passed value, and other values copied from this instance.
static SearchPattern	create(String searchExpression, boolean wholeWords, boolean matchCase, boolean regExp) Creates a new SearchPattern in accordance with given parameters
static SearchPattern	create(String searchExpression, boolean wholeWords, boolean matchCase, SearchPattern.MatchType matchType) Creates a new SearchPattern in accordance with given parameters
boolean	equals(Object obj)
SearchPattern.MatchType	getMatchType() Get type of this pattern.
String	getSearchExpression()
int	hashCode()
boolean	isMatchCase()
boolean	isRegExp()
boolean	isWholeWords()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static SearchPattern create(String searchExpression,
                                   boolean wholeWords,
                                   boolean matchCase,
                                   boolean regExp)

Creates a new SearchPattern in accordance with given parameters

Parameters:

searchExpression - non-null String of a searched text

wholeWords - if true, only whole words were searched

matchCase - if true, case sensitive search was preformed

regExp - if true, regular expression search was performed; if false, search with basic wildcards was performed

Returns:

a new SearchPattern in accordance with given parameters

create

public static SearchPattern create(String searchExpression,
                                   boolean wholeWords,
                                   boolean matchCase,
                                   SearchPattern.MatchType matchType)

Creates a new SearchPattern in accordance with given parameters

Parameters:

searchExpression - non-null String of a searched text

wholeWords - if true, only whole words were searched

matchCase - if true, case sensitive search was preformed

matchType - match type

Returns:

a new SearchPattern in accordance with given parameters

Since:

api.search/1.11

getSearchExpression

public String getSearchExpression()

Returns:

searchExpression

isWholeWords

public boolean isWholeWords()

Returns:

true if the wholeWords parameter was used during search performing

isMatchCase

public boolean isMatchCase()

Returns:

true if the matchCase parameter was used during search performing

isRegExp

public boolean isRegExp()

Returns:

true if the regExp parameter was used during search performing

getMatchType

public SearchPattern.MatchType getMatchType()

Get type of this pattern.

Since:

api.search/1.11

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

changeSearchExpression

public SearchPattern changeSearchExpression(String expression)

Create new instance with "search expression" set to passed value, and other values copied from this instance.

changeWholeWords

public SearchPattern changeWholeWords(boolean wholeWords)

Create new instance with "whole words" set to passed value, and other values copied from this instance.

changeMatchCase

public SearchPattern changeMatchCase(boolean matchCase)

Create new instance with "match case" set to passed value, and other values copied from this instance.

changeRegExp

public SearchPattern changeRegExp(boolean regExp)

Create new instance with "regular expression" set to passed value, and other values copied from this instance.

changeMatchType

public SearchPattern changeMatchType(SearchPattern.MatchType matchType)

Create new instance with "match type" set to passed value, and other values copied from this instance.

Since:

api.search/1.11