org.javasimon

Class SimonPattern

java.lang.Object

org.javasimon.SimonPattern

All Implemented Interfaces:

SimonFilter

public final class SimonPattern
extends Object
implements SimonFilter

Matches Simon name patterns from configuration. Patterns can contain wildcard (*) that can be placed in following fashions:

• empty string matches only Manager.ROOT_SIMON_NAME (root Simon)
• * - matches anything
• something - matches exactly something
• *something - matches if tested name ends with something
• something* - matches if tested name starts with something
• *something* - matches if tested name contains something anywhere
• something*else - matches if tested name starts with something and ends with else
• anything else will throw SimonException with the message about invalid Simon pattern

Without wildcard exact match is required. Every pattern with wildcards always matches with the same string without wildcards (in other words - wildcards matches with nothing as well).

Field Summary

Fields inherited from interface org.javasimon.SimonFilter

ACCEPT_ALL_FILTER

Constructor Summary

Constructors

Constructor and Description
SimonPattern(String pattern) Creates Simon name pattern used to match config file entries.
SimonPattern(String pattern, Class<? extends Simon> expectedType) Creates Simon pattern that used to match Simons of specified type with names that correspond to the pattern.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	accept(Simon simon) Checks whether current Simon should be used/considered.
static SimonPattern	create(String pattern) Factory method that creates Simon name pattern - or returns null if parameter is null.
static SimonPattern	createForCounter(String pattern) Factory method that creates Counter name pattern - or returns a pattern that accepts all Counters if parameter is null.
static SimonPattern	createForStopwatch(String pattern) Factory method that creates Stopwatch name pattern - or returns a pattern that accepts all Stopwatches if parameter is null.
boolean	equals(Object o)
int	hashCode()
boolean	matches(String name) Checks if Simon name matches this pattern.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SimonPattern

public SimonPattern(String pattern)

Creates Simon name pattern used to match config file entries.

Parameters:

pattern - Simon name pattern

Throws:

SimonException - if pattern is not valid (runtime exception)

SimonPattern

public SimonPattern(String pattern,
            Class<? extends Simon> expectedType)

Creates Simon pattern that used to match Simons of specified type with names that correspond to the pattern.

Parameters:

pattern - Simon name pattern

expectedType - expected type of Simon

Throws:

SimonException - if pattern is not valid (runtime exception)

Method Detail

create

public static SimonPattern create(String pattern)

Factory method that creates Simon name pattern - or returns null if parameter is null.

Parameters:

pattern - Simon name pattern as string

Returns:

Simon name pattern or null if pattern parameter is null

createForCounter

public static SimonPattern createForCounter(String pattern)

Factory method that creates Counter name pattern - or returns a pattern that accepts all Counters if parameter is null.

Parameters:

pattern - Counter name pattern as string

Returns:

Counter name pattern

createForStopwatch

public static SimonPattern createForStopwatch(String pattern)

Factory method that creates Stopwatch name pattern - or returns a pattern that accepts all Stopwatches if parameter is null.

Parameters:

pattern - Stopwatch name pattern as string

Returns:

Stopwatch name pattern

accept

public boolean accept(Simon simon)

Description copied from interface: SimonFilter

Checks whether current Simon should be used/considered.

Specified by:

accept in interface SimonFilter

Parameters:

simon - Simon to check

Returns:

true if current Simon should be used, false otherwise

matches

public boolean matches(String name)

Checks if Simon name matches this pattern.

Parameters:

name - tested name

Returns:

true if tested pattern matches this pattern

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object