org.apache.daffodil.japi

Class DataLocation

java.lang.Object

org.apache.daffodil.japi.DataLocation

public class DataLocation
extends java.lang.Object

Information related to a location in data

Constructor Summary

Constructors

Constructor and Description
DataLocation(org.apache.daffodil.api.DataLocation dl)

Method Summary

Modifier and Type	Method and Description
long	bitPos1b() Get the position of the data, in bits, using 1-based indexing
long	bytePos1b() Get the position of the data, in bytes, using 1-based indexing
boolean	isAtEnd() Deprecated. Use comparison of bitPos1b() with expected position instead. Since 3.1.0.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DataLocation

public DataLocation(org.apache.daffodil.api.DataLocation dl)

Method Detail

bitPos1b

public long bitPos1b()

Get the position of the data, in bits, using 1-based indexing

Returns:

position of the data in bits

bytePos1b

public long bytePos1b()

Get the position of the data, in bytes, using 1-based indexing

Returns:

position of the data in bytes

isAtEnd

public boolean isAtEnd()

Deprecated. Use comparison of bitPos1b() with expected position instead. Since 3.1.0.

Determine if we're positioned at the end of data.

Blocks until either one byte of data can be read, or end-of-data is encountered.

It is generally not advised to use this on network TCP data streams as it will block waiting for the sender of data to provide more data or close the stream.

Returns:

boolean indicating whether we are known to be positioned at the end of data.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object