org.bitbucket.jrsofty.parser.logging.api

Class TokenMatcher

java.lang.Object

org.bitbucket.jrsofty.parser.logging.api.TokenMatcher

public class TokenMatcher
extends Object

A container class for holding the regex pattern and token marker used for mapping the token.

Author:

jrsofty

Constructor Summary

Constructors

Constructor and Description
TokenMatcher(String regex, String tokenMarker)

Method Summary

Modifier and Type	Method and Description
String	getPattern() The regex pattern that was used for creating the regex used.
String	getTokenMarker() Delivers the token marker used for mapping.
String	validateToken(String token) Validates the given token with the compiled regex pattern.

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenMatcher

public TokenMatcher(String regex,
                    String tokenMarker)

Method Detail

getPattern

public String getPattern()

The regex pattern that was used for creating the regex used.

Returns:

the regex pattern as String.

getTokenMarker

public String getTokenMarker()

Delivers the token marker used for mapping. Token markers are not always exactly as they were entered in the formatting string. Every token marker will be extended with an instance number.

Returns:

this TokenMatcher's token marker.

validateToken

public String validateToken(String token)
                     throws TokenParseException

Validates the given token with the compiled regex pattern. Returns null if there is not a match.

Parameters:

token - a portion of the log line as String

Returns:

the token value if a match, otherwise returns null.

Throws:

TokenParseException - when a match fails.