src/main/java/org/apache/pdfbox/jbig2/Region.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.pdfbox.jbig2;

import java.io.IOException;

import org.apache.pdfbox.jbig2.err.IntegerMaxValueException;
import org.apache.pdfbox.jbig2.err.InvalidHeaderValueException;
import org.apache.pdfbox.jbig2.segments.RegionSegmentInformation;

/**
 * Interface for all JBIG2 region segments.
 */
public interface Region extends SegmentData
{

    /**
     * Decodes and returns a regions content.
     * 
     * @return The decoded region as {@link Bitmap}.
     * 
     * @throws IOException if an underlying IO operation fails
     * @throws IntegerMaxValueException if the maximum value limit of an integer is exceeded
     * @throws InvalidHeaderValueException if the segment header value is invalid
     */
    public Bitmap getRegionBitmap()
            throws IOException, IntegerMaxValueException, InvalidHeaderValueException;

    /**
     * Simply returns the {@link RegionSegmentInformation}.
     * 
     * @return The {@link RegionSegmentInformation}.
     */
    public RegionSegmentInformation getRegionInfo();
}