org.apache.pdfbox.jbig2

Class SegmentHeader

java.lang.Object

org.apache.pdfbox.jbig2.SegmentHeader

public class SegmentHeader
extends Object

The basic class for all JBIG2 segments.

Constructor Summary

Constructors

Constructor and Description
SegmentHeader(org.apache.pdfbox.jbig2.JBIG2Document document, SubInputStream sis, long offset, int organisationType)

Method Summary

Modifier and Type	Method and Description
void	cleanSegmentData()
SubInputStream	getDataInputStream() Creates and returns a new SubInputStream that provides the data part of this segment.
int	getPageAssociation()
short	getRetainFlag()
SegmentHeader[]	getRtSegments()
SegmentData	getSegmentData() Retrieves the segments' data part.
long	getSegmentDataLength()
long	getSegmentDataStartOffset()
long	getSegmentHeaderLength()
int	getSegmentNr()
int	getSegmentType()
void	setSegmentDataStartOffset(long segmentDataStartOffset)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SegmentHeader

public SegmentHeader(org.apache.pdfbox.jbig2.JBIG2Document document,
                     SubInputStream sis,
                     long offset,
                     int organisationType)
              throws IOException

Throws:

IOException

Method Detail

getSegmentNr

public int getSegmentNr()

getSegmentType

public int getSegmentType()

getSegmentHeaderLength

public long getSegmentHeaderLength()

getSegmentDataLength

public long getSegmentDataLength()

getSegmentDataStartOffset

public long getSegmentDataStartOffset()

setSegmentDataStartOffset

public void setSegmentDataStartOffset(long segmentDataStartOffset)

getRtSegments

public SegmentHeader[] getRtSegments()

getPageAssociation

public int getPageAssociation()

getRetainFlag

public short getRetainFlag()

getDataInputStream

public SubInputStream getDataInputStream()

Creates and returns a new SubInputStream that provides the data part of this segment. It is a clipped view of the source input stream.

Returns:

The SubInputStream that represents the data part of the segment.

getSegmentData

public SegmentData getSegmentData()

Retrieves the segments' data part.

Returns:

Retrieved SegmentData instance.

cleanSegmentData

public void cleanSegmentData()

toString

public String toString()

Overrides:

toString in class Object