zserio.runtime.walker

Class RegexWalkFilter

java.lang.Object

zserio.runtime.walker.RegexWalkFilter

All Implemented Interfaces:

WalkFilter

public final class RegexWalkFilter
extends java.lang.Object
implements WalkFilter

Walk filter which allows to walk only paths matching the given regex. The path is constructed from field names within the root object, thus the root object itself is not part of the path. Array elements have the index appended to the path so that e.g. "compound.arrayField[0]" will match only the first element in the array "arrayField".

Constructor Summary

Constructors

Constructor and Description
RegexWalkFilter(java.lang.String pathRegex) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	afterArray(java.lang.Object array, FieldInfo fieldInfo) Called after an array.
boolean	afterCompound(java.lang.Object compound, FieldInfo fieldInfo, int elementIndex) Called after a compound object.
boolean	afterValue(java.lang.Object value, FieldInfo fieldInfo, int elementIndex) Called after a simple value.
boolean	beforeArray(java.lang.Object array, FieldInfo fieldInfo) Called before an array.
boolean	beforeCompound(java.lang.Object compound, FieldInfo fieldInfo, int elementIndex) Called before a compound object.
boolean	beforeValue(java.lang.Object value, FieldInfo fieldInfo, int elementIndex) Called before a simple (or an unset compound - i.e.

Methods inherited from class java.lang.Object

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

Constructor Detail

RegexWalkFilter

public RegexWalkFilter(java.lang.String pathRegex)

Constructor.

Parameters:

pathRegex - Path regex to use for filtering.

Method Detail

beforeArray

public boolean beforeArray(java.lang.Object array,
                           FieldInfo fieldInfo)

Description copied from interface: WalkFilter

Called before an array.

Specified by:

beforeArray in interface WalkFilter

Parameters:

array - Zserio array.

fieldInfo - Array field info.

Returns:

True when the walking should continue to the array.

afterArray

public boolean afterArray(java.lang.Object array,
                          FieldInfo fieldInfo)

Description copied from interface: WalkFilter

Called after an array.

Specified by:

afterArray in interface WalkFilter

Parameters:

array - Zserio array.

fieldInfo - Array field info.

Returns:

True when the walking should continue to a next sibling, false to return to the parent.

beforeCompound

public boolean beforeCompound(java.lang.Object compound,
                              FieldInfo fieldInfo,
                              int elementIndex)

Description copied from interface: WalkFilter

Called before a compound object. Note that for uninitialized compounds (i.e. null) the before_value method is called instead!

Specified by:

beforeCompound in interface WalkFilter

Parameters:

compound - Compound zserio object.

fieldInfo - Compound field info.

elementIndex - Element index in array or NOT_ELEMENT if the compound is not in array.

Returns:

True when the walking should continue into the compound object, false otherwise.

afterCompound

public boolean afterCompound(java.lang.Object compound,
                             FieldInfo fieldInfo,
                             int elementIndex)

Description copied from interface: WalkFilter

Called after a compound object.

Specified by:

afterCompound in interface WalkFilter

Parameters:

compound - Compound zserio object.

fieldInfo - Compound field info.

elementIndex - Element index in array or NOT_ELEMENT if the compound is not in array.

Returns:

True when the walking should continue to a next sibling, false to return to the parent.

beforeValue

public boolean beforeValue(java.lang.Object value,
                           FieldInfo fieldInfo,
                           int elementIndex)

Description copied from interface: WalkFilter

Called before a simple (or an unset compound - i.e. null) value.

Specified by:

beforeValue in interface WalkFilter

Parameters:

value - Simple value.

fieldInfo - Field info of the value.

elementIndex - Element index in array or NOT_ELEMENT if the compound is not in array.

Returns:

True when the walking should continue to the simple value, false otherwise.

afterValue

public boolean afterValue(java.lang.Object value,
                          FieldInfo fieldInfo,
                          int elementIndex)

Description copied from interface: WalkFilter

Called after a simple value.

Specified by:

afterValue in interface WalkFilter

Parameters:

value - Simple value.

fieldInfo - Field info of the value.

elementIndex - Element index in array or NOT_ELEMENT if the compound is not in array.

Returns:

True when the walking should continue to a next sibling, false to return to the parent.