1 /*
   2  * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 package com.sun.awt;
  26 
  27 import java.awt.Image;
  28 
  29 /**
  30  * This interface is designed to provide a set of images at various resolutions.
  31  *
  32  * <b>WARNING</b>: This class is an implementation detail. This API may change
  33  * between update release, and it may even be removed or be moved in some other
  34  * package(s)/class(es).
  35  */
  36 public interface MultiResolutionImage {
  37 
  38     /**
  39      * Provides an image with necessary resolution which best fits to the given
  40      * image width and height.
  41      *
  42      * The method should be overridden by any class whose instances are intended
  43      * to provide image resolution variants according to the given image width
  44      * and height. For example,
  45      * <pre>
  46      * {@code
  47      *  public class ScaledImage extends BufferedImage
  48      *         implements MultiResolutionImage {
  49      *    @Override
  50      *    public Image getResolutionVariant(int width, int height) {
  51      *      return ((width <= getWidth() && height <= getHeight()))
  52      *             ? this : highResolutionImage;
  53      *    }
  54      *  }
  55      * }</pre>
  56      *
  57      * It is recomended to cache image variants for performance reasons.
  58      *
  59      * @param width the desired image resolution width.
  60      * @param height the desired image resolution height.
  61      * @return image resolution variant.
  62      *
  63      * @since JDK1.8
  64      */
  65     public Image getResolutionVariant(int width, int height);
  66 }