org.jplate.kvp.parser
Interface KvpParseContextIfc<P extends KvpParseContextIfc>

All Superinterfaces:
FormattableIfc, PrototypeIfc<P>
All Known Implementing Classes:
DefaultKvpParseContext

public interface KvpParseContextIfc<P extends KvpParseContextIfc>
extends FormattableIfc, PrototypeIfc<P>

Used when parsing to hold state.

Modifications:
    $Date: 2008-12-02 12:32:45 -0500 (Tue, 02 Dec 2008) $
    $Revision: 479 $
    $Author: sfloess $
    $HeadURL: https://jplate.svn.sourceforge.net/svnroot/jplate/trunk/src/dev/java/org/jplate/kvp/parser/KvpParseContextIfc.java $
    


Method Summary
 java.lang.String getKey()
          Return the key.
 int getKeyColumn()
          Return the column where key was found.
 int getKeyLine()
          Return the line where key was found.
 java.lang.String getValue()
          Return the value.
 int getValueColumn()
          Return the column where value was found.
 int getValueLine()
          Return the line where value was found.
 void populate(KvpIfc kvp)
          Use the values contained within to populatete kvp.
 void setKey(java.lang.String key, int line, int column)
          This method sets information about the key.
 void setValue(java.lang.String value, int line, int column)
          This method sets information about the value.
 
Methods inherited from interface org.jplate.foundation.FormattableIfc
toString
 
Methods inherited from interface org.jplate.foundation.gof.prototype.PrototypeIfc
createCopy, createInstance
 

Method Detail

getKey

java.lang.String getKey()
Return the key.

Returns:
The key.

getKeyLine

int getKeyLine()
Return the line where key was found.

Returns:
The line where key was found.

getKeyColumn

int getKeyColumn()
Return the column where key was found.

Returns:
The column where key was found.

setKey

void setKey(java.lang.String key,
            int line,
            int column)
This method sets information about the key.

Parameters:
key - The key encountered.
line - The line where key begins.
column - The column number where key begins.

getValue

java.lang.String getValue()
Return the value.

Returns:
The value.

getValueLine

int getValueLine()
Return the line where value was found.

Returns:
The line where value was found.

getValueColumn

int getValueColumn()
Return the column where value was found.

Returns:
The column where value was found.

setValue

void setValue(java.lang.String value,
              int line,
              int column)
This method sets information about the value.

Parameters:
value - The value encountered.
line - The line where value begins.
column - The column number where value begins.

populate

void populate(KvpIfc kvp)
Use the values contained within to populatete kvp.

Parameters:
kvp - The key/value pair to populate.