jodd.madvoc.macro

Interface PathMacros

All Known Implementing Classes:

BasePathMacros, RegExpPathMacros, WildcardPathMacros

public interface PathMacros

Action path macros.

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.
java.lang.String[]	names() Returns names of all macros.
java.lang.String[]	patterns() Returns all patterns.

Method Detail

init

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.

names

java.lang.String[] names()

Returns names of all macros.

patterns

java.lang.String[] patterns()

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

macrosCount

int macrosCount()

Returns macros count.

match

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.

extract

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 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.