Class MapPageSegment

  • All Implemented Interfaces:
    Streamable

    public class MapPageSegment
    extends AbstractAFPObject
    The Map Page Segment structured field identifies page segments that are required to present a page on a physical medium.
    • Field Detail

      • pageSegments

        private java.util.Set pageSegments
        The collection of page segments (maximum of 127 stored as String)
    • Constructor Detail

      • MapPageSegment

        public MapPageSegment()
        Constructor for the Map Page Overlay
    • Method Detail

      • getPageSegments

        private java.util.Set getPageSegments()
      • addPageSegment

        public void addPageSegment​(java.lang.String name)
                            throws MaximumSizeExceededException
        Add a page segment to to the map page segment object.
        Parameters:
        name - the name of the page segment.
        Throws:
        MaximumSizeExceededException - if the maximum size is reached
      • isFull

        public boolean isFull()
        Indicates whether this object already contains the maximum number of page segments.
        Returns:
        true if the object is full
      • writeToStream

        public void writeToStream​(java.io.OutputStream os)
                           throws java.io.IOException
        DataStream objects must implement the writeToStream() method to write its data to the given OutputStream
        Parameters:
        os - the outputsteam stream
        Throws:
        java.io.IOException - an I/O exception of some sort has occurred.