awt/java/awt/image/ImageProducer.java

   1 /*
   2  *  Licensed to the Apache Software Foundation (ASF) under one or more
   3  *  contributor license agreements.  See the NOTICE file distributed with
   4  *  this work for additional information regarding copyright ownership.
   5  *  The ASF licenses this file to You under the Apache License, Version 2.0
   6  *  (the "License"); you may not use this file except in compliance with
   7  *  the License.  You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  *  Unless required by applicable law or agreed to in writing, software
  12  *  distributed under the License is distributed on an "AS IS" BASIS,
  13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  *  See the License for the specific language governing permissions and
  15  *  limitations under the License.
  16  */
  17 /**
  18  * @author Igor V. Stolyarov
  19  * @version $Revision$
  20  */
  21
  22 package java.awt.image;
  23
  24 /**
  25  * The ImageProducer provides an interface for objects which produce the image
  26  * data. ImageProducer is used for reconstructing the image. Each image contains
  27  * an ImageProducer.
  28  *
  29  * @since Android 1.0
  30  */
  31 public interface ImageProducer {
  32
  33     /**
  34      * Checks if the specified ImageConsumer is registered with this
  35      * ImageProvider or not.
  36      *
  37      * @param ic
  38      *            the ImageConsumer to be checked.
  39      * @return true, if the specified ImageConsumer is registered with this
  40      *         ImageProvider, false otherwise.
  41      */
  42     public boolean isConsumer(ImageConsumer ic);
  43
  44     /**
  45      * Starts a reconstruction of the image data which will be delivered to this
  46      * consumer. This method adds the specified ImageConsumer before
  47      * reconstructing the image.
  48      *
  49      * @param ic
  50      *            the specified ImageConsumer.
  51      */
  52     public void startProduction(ImageConsumer ic);
  53
  54     /**
  55      * Requests the ImageProducer to resend the image data in
  56      * ImageConsumer.TOPDOWNLEFTRIGHT order.
  57      *
  58      * @param ic
  59      *            the specified ImageConsumer.
  60      */
  61     public void requestTopDownLeftRightResend(ImageConsumer ic);
  62
  63     /**
  64      * Deregisters the specified ImageConsumer.
  65      *
  66      * @param ic
  67      *            the specified ImageConsumer.
  68      */
  69     public void removeConsumer(ImageConsumer ic);
  70
  71     /**
  72      * Adds the specified ImageConsumer object to this ImageProducer.
  73      *
  74      * @param ic
  75      *            the specified ImageConsumer.
  76      */
  77     public void addConsumer(ImageConsumer ic);
  78
  79 }