Custom Field Parsers

If none of the standard parsing strategies allow you to correctly parse data from the message buffer, you can customize the field parser. To do so, you must provide a Java class that implements the com.sybase.jtf.parser.api.ICustomParserField interface. This interface is contained in the pgen.jar file, which is provided with the WorkSpace Message Designer.

// package declaration
package com.sybase.jtf.parser.api;

/**
 * The ICustomParserField interface provides an extension point in which 
 * clients can develop custom code to define a means of parsing a field 
 * that is not defined in the standard API.
 */
public interface ICustomParserField {

        /**
         * 
         * 
         * @param buffer The message buffer.
         * @param offset The offset into the buffer.
         * @param max   The maximum offset within the buffer.
         * @param result The result of the parse.
         * @param name  The name of the component.
         * 
         * @return The number of bytes consumed or -1 meaning failure.
         */
        public int parseField(byte[] buffer, int offset, int max, ParseResult result, String name);
}