/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/**
* The interface for objects which can produce the image data for Images.
* Each image contains an ImageProducer which is used to reconstruct
* the image whenever it is needed, for example, when a new size of the
* Image is scaled, or when the width or height of the Image is being
* requested.
*
* @see ImageConsumer
*
* @author Jim Graham
*/
public interface ImageProducer {
/**
* Registers an <code>ImageConsumer</code> with the
* <code>ImageProducer</code> for access to the image data
* during a later reconstruction of the <code>Image</code>.
* The <code>ImageProducer</code> may, at its discretion,
* start delivering the image data to the consumer
* using the <code>ImageConsumer</code> interface immediately,
* or when the next available image reconstruction is triggered
* by a call to the <code>startProduction</code> method.
* @param ic the specified <code>ImageConsumer</code>
* @see #startProduction
*/
/**
* Determines if a specified <code>ImageConsumer</code>
* object is currently registered with this
* <code>ImageProducer</code> as one of its consumers.
* @param ic the specified <code>ImageConsumer</code>
* @return <code>true</code> if the specified
* <code>ImageConsumer</code> is registered with
* this <code>ImageProducer</code>;
* <code>false</code> otherwise.
*/
/**
* Removes the specified <code>ImageConsumer</code> object
* from the list of consumers currently registered to
* receive image data. It is not considered an error
* to remove a consumer that is not currently registered.
* The <code>ImageProducer</code> should stop sending data
* to this consumer as soon as is feasible.
* @param ic the specified <code>ImageConsumer</code>
*/
/**
* Registers the specified <code>ImageConsumer</code> object
* as a consumer and starts an immediate reconstruction of
* the image data which will then be delivered to this
* consumer and any other consumer which might have already
* been registered with the producer. This method differs
* from the addConsumer method in that a reproduction of
* the image data should be triggered as soon as possible.
* @param ic the specified <code>ImageConsumer</code>
* @see #addConsumer
*/
/**
* Requests, on behalf of the <code>ImageConsumer</code>,
* that the <code>ImageProducer</code> attempt to resend
* the image data one more time in TOPDOWNLEFTRIGHT order
* so that higher quality conversion algorithms which
* depend on receiving pixels in order can be used to
* produce a better output version of the image. The
* <code>ImageProducer</code> is free to
* ignore this call if it cannot resend the data in that
* order. If the data can be resent, the
* <code>ImageProducer</code> should respond by executing
* the following minimum set of <code>ImageConsumer</code>
* method calls:
* <pre>
* ic.setHints(TOPDOWNLEFTRIGHT | < otherhints >);
* ic.setPixels(...); // As many times as needed
* ic.imageComplete();
* </pre>
* @param ic the specified <code>ImageConsumer</code>
* @see ImageConsumer#setHints
*/
}