GifImagingParameters.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
 *
 *      https://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.commons.imaging.formats.gif;

import org.apache.commons.imaging.common.XmpImagingParameters;

/**
 * GIF format parameters.
 *
 * @since 1.0-alpha3
 */
public class GifImagingParameters extends XmpImagingParameters<GifImagingParameters> {

    /**
     * Gets whether to stop reading before image data from the parameters.
     *
     * @param params the parameters.
     * @return true if should stop reading before image data, false otherwise.
     */
    public static boolean getStopReadingBeforeImageData(final GifImagingParameters params) {
        return params != null && params.getStopReadingBeforeImageData();
    }

    private boolean stopReadingBeforeImageData;

    /**
     * Constructs a new instance.
     */
    public GifImagingParameters() {
    }

    /**
     * Gets whether to stop reading before image data.
     *
     * @return true if should stop reading before image data, false otherwise.
     */
    public boolean getStopReadingBeforeImageData() {
        return stopReadingBeforeImageData;
    }

    /**
     * Sets whether to stop reading before image data.
     *
     * @param stopReadingBeforeImageData true to stop reading before image data, false otherwise.
     */
    public void setStopReadingBeforeImageData(final boolean stopReadingBeforeImageData) {
        this.stopReadingBeforeImageData = stopReadingBeforeImageData;
    }

}