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 sun.awt.image;

    26 

    27 import java.awt.Image;

    28 import java.util.List;

    29 

    30 /**

    31  * This interface is designed to provide a set of images at various resolutions.

    32  *

    33  * The <code>MultiResolutionImage</code> interface should be implemented by any

    34  * class whose instances are intended to provide image resolution variants

    35  * according to the given image width and height.

    36  *

    37  * For example,

    38  * <pre>

    39  * {@code

    40  *  public class ScaledImage extends BufferedImage

    41  *         implements MultiResolutionImage {

    42  *

    43  *    @Override

    44  *    public Image getResolutionVariant(int width, int height) {

    45  *      return ((width <= getWidth() && height <= getHeight()))

    46  *             ? this : highResolutionImage;

    47  *    }

    48  *

    49  *    @Override

    50  *    public List<Image> getResolutionVariants() {

    51  *        return Arrays.asList(this, highResolutionImage);

    52  *    }

    53  *  }

    54  * }</pre>

    55  *

    56  * It is recommended to cache image variants for performance reasons.

    57  *

    58  * <b>WARNING</b>: This class is an implementation detail. This API may change

    59  * between update release, and it may even be removed or be moved in some other

    60  * package(s)/class(es).

    61  */

    62 public interface MultiResolutionImage {

    63 

    64     /**

    65      * Provides an image with necessary resolution which best fits to the given

    66      * image width and height.

    67      *

    68      * @param width the desired image resolution width.

    69      * @param height the desired image resolution height.

    70      * @return image resolution variant.

    71      *

    72      * @since 1.8

    73      */

    74     public Image getResolutionVariant(int width, int height);

    75 

    76     /**

    77      * Gets list of all resolution variants including the base image

    78      *

    79      * @return list of resolution variants.

    80      * @since 1.8

    81      */

    82     public List<Image> getResolutionVariants();

    83 }