commons-compiler 3.1.12 · org.codehaus.commons.compiler.util.StringPattern

Field Summary

Modifier and Type	Field and Description
public static final int	EXCLUDE
public static final int	INCLUDE
private final int	mode
private final String	pattern
public static final StringPattern[]	PATTERNS_ALL A `StringPattern` that matches any subject.
public static final StringPattern[]	PATTERNS_NONE A `StringPattern` that matches no subject whatsoever.

Constructor Summary

Access	Constructor and Description
public	StringPattern(int `INCLUDE` or `EXCLUDE` mode, String pattern)
public	StringPattern(String pattern)

Method Summary

Modifier and Type	Method and Description
public int	Returns: Whether this `StringPattern` represents inclusion (`INCLUDE`) or exclusion exclusion (`EXCLUDE`) of subjects getMode()
public boolean	matches(String text) Matches the given `text` against the pattern represented by the current instance, as follows: A `*` in the pattern matches any sequence of zero or more characters in the `text` A `?` in the pattern matches exactly one character in the `text` Any other character in the pattern must appear exactly as it is in the `text`
public static boolean	matches(StringPattern[] patterns, String text) Matchs a given `text` against an array of `StringPattern`s (which was typically created by `parseCombinedPattern(String)`.
public static StringPattern[]	parseCombinedPattern(String combinedPattern) Parses a "combined pattern" into an array of `StringPattern`s.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private static boolean	wildmatch(String pattern, String text)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

EXCLUDE	back to summary
public static final int EXCLUDE See Also `matches(StringPattern[], String)`

INCLUDE	back to summary
public static final int INCLUDE See Also `matches(StringPattern[], String)`

mode	back to summary
private final int mode

pattern	back to summary
private final String pattern Annotations @Nullable

PATTERNS_ALL	back to summary
public static final StringPattern[] PATTERNS_ALL A `StringPattern` that matches any subject.

PATTERNS_NONE	back to summary
public static final StringPattern[] PATTERNS_NONE A `StringPattern` that matches no subject whatsoever.

Constructor Detail

StringPattern	back to summary
public StringPattern(int mode, String pattern) Parameters mode:int `INCLUDE` or `EXCLUDE`

StringPattern	back to summary
public StringPattern(String pattern)

Method Detail

getMode	back to summary
public int getMode() Returns:int Whether this `StringPattern` represents inclusion (`INCLUDE`) or exclusion exclusion (`EXCLUDE`) of subjects

matches back to summary

matches	back to summary
public boolean matches(String text) Matches the given `text` against the pattern represented by the current instance, as follows: A `*` in the pattern matches any sequence of zero or more characters in the `text` A `?` in the pattern matches exactly one character in the `text` Any other character in the pattern must appear exactly as it is in the `text` Notice: The `mode` flag of the current instance does not take any effect here.

public boolean matches(String text)

Matches the given text against the pattern represented by the current instance, as follows:

A * in the pattern matches any sequence of zero or more characters in the text
A ? in the pattern matches exactly one character in the text
Any other character in the pattern must appear exactly as it is in the text

Notice: The mode flag of the current instance does not take any effect here.

matches back to summary

matches	back to summary
public static boolean matches(StringPattern[] patterns, String text) Matchs a given `text` against an array of `StringPattern`s (which was typically created by `parseCombinedPattern(String)`. The last matching pattern takes effect; if its mode is `INCLUDE`, then `true` is returned, if its mode is `EXCLUDE`, then `false` is returned. If `patterns` is `PATTERNS_NONE`, or empty, or none of its patterns matches, then `false` is returned. If `patterns` is `PATTERNS_ALL`, then `true` is returned. For backwards compatibility, `null` patterns are treated like `PATTERNS_NONE`. Annotations @SuppressWarnings:unused, null

public static boolean matches(StringPattern[] patterns, String text)

Matchs a given text against an array of StringPatterns (which was typically created by parseCombinedPattern(String).

The last matching pattern takes effect; if its mode is INCLUDE, then true is returned, if its mode is EXCLUDE, then false is returned.

If patterns is PATTERNS_NONE, or empty, or none of its patterns matches, then false is returned.

If patterns is PATTERNS_ALL, then true is returned.

For backwards compatibility, null patterns are treated like PATTERNS_NONE.

Annotations

@SuppressWarnings:unused, null

parseCombinedPattern back to summary

parseCombinedPattern	back to summary
public static StringPattern[] parseCombinedPattern(String combinedPattern) Parses a "combined pattern" into an array of `StringPattern`s. A combined pattern string is structured as follows: combined-pattern := [ '+' \| '-' ] pattern { ( '+' \| '-' ) pattern } If a pattern is preceeded with a '-', then the `StringPattern` is created with mode `EXCLUDE`, otherwise with mode `INCLUDE`.

public static StringPattern[] parseCombinedPattern(String combinedPattern)

Parses a "combined pattern" into an array of StringPatterns. A combined pattern string is structured as follows:

  combined-pattern :=
    [ '+' | '-' ] pattern
    { ( '+' | '-' ) pattern }

If a pattern is preceeded with a '-', then the StringPattern is created with mode EXCLUDE, otherwise with mode INCLUDE.

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.