jodd.madvoc.macro

Class BasePathMacros

java.lang.Object

jodd.madvoc.macro.BasePathMacros

All Implemented Interfaces:

PathMacros

Direct Known Subclasses:

RegExpPathMacros, WildcardPathMacros

public abstract class BasePathMacros
extends java.lang.Object
implements PathMacros

Common class for PathMacro implementations. Assume that macros are defined in the following way: prefix{name:pattern}suffix. Pattern is optional, and if missing all values are matched.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String[]	fixed
protected int	macrosCount
protected java.lang.String[]	names
protected java.lang.String[]	patterns

Constructor Summary

Constructors

Constructor and Description
BasePathMacros()

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	extract(java.lang.String actionPath) Extracts array of macro values for matched action path for each name.
boolean	init(java.lang.String actionPath, java.lang.String[] separators) Initializes PathMacro and returns true if macros are found in the action path.
int	macrosCount() Returns macros count.
int	match(java.lang.String actionPath) Match provided action path with the path macros, Returns the number of matched non-macro characters.
protected abstract boolean	matchValue(int macroIndex, java.lang.String value) Matches the stripped value with the pattern.
java.lang.String[]	names() Returns names of all macros.
java.lang.String[]	patterns() Returns all patterns.

Methods inherited from class java.lang.Object

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

Field Detail

macrosCount

protected int macrosCount

names

protected java.lang.String[] names

patterns

protected java.lang.String[] patterns

fixed

protected java.lang.String[] fixed

Constructor Detail

BasePathMacros

public BasePathMacros()

Method Detail

init

public boolean init(java.lang.String actionPath,
                    java.lang.String[] separators)

Initializes PathMacro and returns true if macros are found in the action path. Otherwise, returns false and the instance can be thrown away.

Separators is array of 3 strings that defines: start, dividing string, and end of a macro.

Specified by:

init in interface PathMacros

names

public java.lang.String[] names()

Returns names of all macros.

Specified by:

names in interface PathMacros

patterns

public java.lang.String[] patterns()

Returns all patterns. Some elements may be null if some macro does not define a pattern.

Specified by:

patterns in interface PathMacros

macrosCount

public int macrosCount()

Returns macros count.

Specified by:

macrosCount in interface PathMacros

match

public int match(java.lang.String actionPath)

Match provided action path with the path macros, Returns the number of matched non-macro characters. Returns -1 if action path is not matched.

Specified by:

match in interface PathMacros

matchValue

protected abstract boolean matchValue(int macroIndex,
                                      java.lang.String value)

Matches the stripped value with the pattern. Pattern at provided macroIndex is not null!

extract

public java.lang.String[] extract(java.lang.String actionPath)

Extracts array of macro values for matched action path for each name. It is assumed that path macro was previously PathMacros.init(String, String[]) initialized} on this action path, i.e. input is not validated.

Returned array string of macro values may contain null on all ignored macros.

Specified by:

extract in interface PathMacros