BoxHolder (JHOVE - JSTOR/Harvard Object Validation Environment 1.16.0 API)

java.lang.Object
- edu.harvard.hul.ois.jhove.module.jpeg2000.BoxHolder

All Implemented Interfaces:

Iterator<Object>

Direct Known Subclasses:

JP2Box, TopLevelBoxHolder
```
public class BoxHolder
extends Object
implements Iterator<Object>
```
A BoxHolder is a container for JPEG 2000 boxes.

Author:

Gary McGath

Field Summary

Fields
Modifier and Type	Field and Description
`protected BoxHeader`	`_boxHeader`
`protected DataInputStream`	`_dstrm`
`protected Jpeg2000Module`	`_module`
`protected JP2Box`	`_parentBox`
`protected RandomAccessFile`	`_raf`
`protected RepInfo`	`_repInfo`
`protected long`	`bytesLeft`
`protected long`	`filePos`
`protected boolean`	`hasBoxes`

Constructor Summary

Constructors
Constructor and Description

BoxHolder(RandomAccessFile raf)
Constructor.

Constructors
Constructor and Description
`BoxHolder(RandomAccessFile raf)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected long`	`getFilePos()` Returns the file position.
`protected String`	`getSelfPropName()` Returns the name of the BoxHolder.
`boolean`	`hasNext()` Checks if any more subboxes are available.
`Object`	`next()`
`void`	`remove()` Always throws UnsupportedOperationException.
`protected void`	`superboxOverrun()` Utility error reporting function for a subbox overrunning its superbox.
`protected void`	`superboxUnderrun()` Utility error reporting function for a subbox underrunning its superbox.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Iterator
forEachRemaining

- Field Detail
  - _module
```
protected Jpeg2000Module _module
```
  - _parentBox
```
protected JP2Box _parentBox
```
  - _raf
```
protected RandomAccessFile _raf
```
  - _dstrm
```
protected DataInputStream _dstrm
```
  - _boxHeader
```
protected BoxHeader _boxHeader
```
  - _repInfo
```
protected RepInfo _repInfo
```
  - bytesLeft
```
protected long bytesLeft
```
  - filePos
```
protected long filePos
```
  - hasBoxes
```
protected boolean hasBoxes
```
- Constructor Detail
  - BoxHolder
```
public BoxHolder(RandomAccessFile raf)
```
    Constructor.
- Method Detail
  - getFilePos
```
protected long getFilePos()
```
    Returns the file position. In practice, this means returning the beginning of the Box.
  - hasNext
```
public boolean hasNext()
```
    Checks if any more subboxes are available. This class doesn't fully conform to the Iterator interface, as there are some cases where the lack of more boxes won't be detected till an EOF is encounterd. So callers should call hasNext to avoid reading overruns, and then test the value returned by next for nullity.
    
    Specified by:
    
    hasNext in interface Iterator<Object>
  - next
```
public Object next()
```
    Specified by:
    
    next in interface Iterator<Object>
  - remove
```
public void remove()
            throws UnsupportedOperationException
```
    Always throws UnsupportedOperationException.
    
    Specified by:
    
    remove in interface Iterator<Object>
    
    Throws:
    
    UnsupportedOperationException
  - superboxOverrun
```
protected void superboxOverrun()
```
    Utility error reporting function for a subbox overrunning its superbox. Sets the RepInfo's wellFormed flag to false.
  - superboxUnderrun
```
protected void superboxUnderrun()
```
    Utility error reporting function for a subbox underrunning its superbox. Sets the RepInfo's wellFormed flag to false.
  - getSelfPropName
```
protected String getSelfPropName()
```
    Returns the name of the BoxHolder. All subclasses should override this.

Class BoxHolder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Iterator

Field Detail

_module

_parentBox

_raf

_dstrm

_boxHeader

_repInfo

bytesLeft

filePos

hasBoxes

Constructor Detail

BoxHolder

Method Detail

getFilePos

hasNext

next

remove

superboxOverrun

superboxUnderrun

getSelfPropName