intradoc.common
Class IdcPosition

java.lang.Object
  |
  +--intradoc.common.IdcPosition

public class IdcPosition

extends java.lang.Object

Constructor Summary

IdcPosition(int value, boolean isField)
Creates an IdcFieldPosition object for the given field.

Method Summary

boolean	equals(java.lang.Object obj) Tests objects for equality
int	getBeginIndex() Retrieves the index of the first character in the requested field.
int	getEndIndex() Retrieves the index of the character following the last character in the requested field.
int	getErrorIndex() Retrieve the index at which an error occurred, or -1 if the error index has not been set.
int	getField() Retrieves the field identifier.
int	getIndex() Retrieve the current parse position.
void	setBeginIndex(int bi) Sets the begin index.
void	setEndIndex(int ei) Sets the end index.
void	setErrorIndex(int ei) Set the index at which a parse error occurred.
void	setIndex(int index) Set the current parse position.
java.lang.String	toString() Return a string representation of this IdcFieldPosition.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdcPosition

public IdcPosition(int value,
                   boolean isField)

Creates an IdcFieldPosition object for the given field. Fields are identified by constants, whose names typically end with _FIELD, in the various subclasses of Format.

See Also:

IdcNumberFormat.INTEGER_FIELD, IdcNumberFormat.FRACTION_FIELD

Method Detail

getField

public int getField()

Retrieves the field identifier.

getBeginIndex

public int getBeginIndex()

Retrieves the index of the first character in the requested field.

getEndIndex

public int getEndIndex()

Retrieves the index of the character following the last character in the requested field.

setBeginIndex

public void setBeginIndex(int bi)

Sets the begin index. For use by subclasses of Format.

setEndIndex

public void setEndIndex(int ei)

Sets the end index. For use by subclasses of Format.

getIndex

public int getIndex()

Retrieve the current parse position. On input to a parse method, this is the index of the character at which parsing will begin; on output, it is the index of the character following the last character parsed.

setIndex

public void setIndex(int index)

Set the current parse position.

getErrorIndex

public int getErrorIndex()

Retrieve the index at which an error occurred, or -1 if the error index has not been set.

setErrorIndex

public void setErrorIndex(int ei)

Set the index at which a parse error occurred. Formatters should set this before returning an error code from their parseObject method. The default value is -1 if this is not set.

equals

public boolean equals(java.lang.Object obj)

Tests objects for equality

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Return a string representation of this IdcFieldPosition.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this object