XMLBox (JHOVE Documentation)
Date: 2013-09-08

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## edu.harvard.hul.ois.jhove.module.jpeg2000
Class XMLBox

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

All Implemented Interfaces:
  java.util.Iterator<java.lang.Object>

    public class XMLBox

extends JP2Box

XML Box. See I.7.1 in ISO/IEC 15444-1:2000

Author:
  Gary McGath

Field Summary

Fields inherited from class edu.harvard.hul.ois.jhove.module.jpeg2000.JP2Box
`_bytesRead, associations, DESCRIPTION_NAME, noJP2Hdr, startBytesRead`

Fields inherited from class edu.harvard.hul.ois.jhove.module.jpeg2000.BoxHolder
`_boxHeader, _dstrm, _module, _parentBox, _raf, _repInfo, bytesLeft, filePos, hasBoxes`

Constructor Summary
`XMLBox(java.io.RandomAccessFile raf, BoxHolder parent)` Constructor with superbox.

Method Summary
`protected Property` | `getSelfPropDesc()` Returns a Property which describes the Box, for use by Association boxes and perhaps others.
`protected java.lang.String` | `getSelfPropName()` Returns the name of the Box.
`boolean` | `readBox()` Reads the box, putting appropriate information in the RepInfo object.

Methods inherited from class edu.harvard.hul.ois.jhove.module.jpeg2000.JP2Box
`addAssociation, boxMaker, emptyBox, finalizeBytesRead, getBytesRead, getLength, init, initBytesRead, makeAssocProperty, selfDescProperty, setBoxHeader, setDataInputStream, setModule, setRandomAccessFile, setRepInfo, skipBox, wrongBoxContext, wrongBoxSize`

Methods inherited from class edu.harvard.hul.ois.jhove.module.jpeg2000.BoxHolder
`getFilePos, hasNext, next, remove, superboxOverrun, superboxUnderrun`

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

Constructor Detail

### XMLBox

    public XMLBox(java.io.RandomAccessFile raf,
                  BoxHolder parent)

  Constructor with superbox.

  Parameters:
    `parent` - parent superbox of this box

Method Detail

### readBox

    public boolean readBox()
                    throws java.io.IOException

  Reads the box, putting appropriate information in the RepInfo object. setModule, setBoxHeader, setRepInfo and setDataInputStream must be called before `readBox` is called. `readBox` must completely consume the box, so that the next byte to be read by the DataInputStream is the `FF` byte of the next Box.

  Specified by:
    `readBox` in class `JP2Box`
  Throws:
    `java.io.IOException`

### getSelfPropDesc

    protected Property getSelfPropDesc()

  Returns a Property which describes the Box, for use by Association boxes and perhaps others.

  Overrides:
    `getSelfPropDesc` in class `JP2Box`

### getSelfPropName

    protected java.lang.String getSelfPropName()

  Returns the name of the Box.

  Overrides:
    `getSelfPropName` in class `JP2Box`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD