com.anrisoftware.resources.images.api.ImageResource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of resources-images Show documentation
Image resources.
There is a newer version: 4.7.0
/*
 * Copyright 2012-2016 Erwin Müller 
 *
 * This file is part of resources-images.
 *
 * resources-images is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * resources-images 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 for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with resources-images. If not, see .
 */
package com.anrisoftware.resources.images.api;

import java.awt.Dimension;
import java.awt.Image;
import java.awt.image.BufferedImage;
import java.awt.image.ImageObserver;

import com.anrisoftware.resources.api.Resource;
import com.anrisoftware.resources.api.ResourcesException;

/**
 * Image resource with lazy loading.
 *
 * @author Erwin Mueller, [email protected]
 * @since 1.0
 */
public interface ImageResource extends Resource {

    /**
     * Returns the resolution of the image resource.
     *
     * @return the {@link ImageResolution}.
     */
    ImageResolution getResolution();

    /**
     * Returns the image of the resource. It will lazy load the resource.
     *
     * @return the {@link Image}.
     *
     * @throws ResourcesException
     *             if the loading of the resource is failed.
     */
    Image getImage() throws ResourcesException;

    /**
     * Returns the image of the resource. It will lazy load the resource.
     *
     * @param observer
     *            the {@link ImageObserver} that is notified when notifications
     *            about loaded image information.
     *
     * @return the {@link Image}.
     *
     * @throws ResourcesException
     *             if the loading of the resource is failed.
     *
     * @since 1.16
     */
    Image getImage(ImageObserver observer) throws ResourcesException;

    /**
     * Returns the buffered image of the resource. It will lazy load the
     * resource.
     *
     * @param imageType
     *            the image {@link Integer} type.
     *
     * @return the {@link BufferedImage}.
     *
     * @throws ResourcesException
     *             if the loading of the resource is failed.
     *
     * @since 1.16
     * @see BufferedImage.TYPE_INT_ARGB
     */
    BufferedImage getBufferedImage(int imageType) throws ResourcesException;

    /**
     * Returns the buffered image of the resource. It will lazy load the
     * resource.
     *
     * @param imageType
     *            the image {@link Integer} type.
     *
     * @param observer
     *            the {@link ImageObserver} that is notified when notifications
     *            about loaded image information.
     *
     * @return the {@link BufferedImage}.
     *
     * @throws ResourcesException
     *             if the loading of the resource is failed.
     *
     * @since 1.16
     * @see BufferedImage.TYPE_INT_ARGB
     */
    BufferedImage getBufferedImage(int imageType, ImageObserver observer)
            throws ResourcesException;

    /**
     * Returns the width of the image. The method will block until the width is
     * available from the image.
     *
     * @return the width of the image in pixels.
     *
     * @throws ResourcesException
     *             if the loading of the resource is failed.
     *
     * @since 1.3
     */
    int getWidthPx() throws ResourcesException;

    /**
     * Returns the width of the image. The specified observer is notified when
     * the width is available.
     *
     * @param observer
     *            the {@link ImageObserver}.
     *
     * @return the width of the image in pixels.
     *
     * @throws ResourcesException
     *             if the loading of the resource is failed.
     *
     * @since 1.16
     */
    int getWidthPx(ImageObserver observer) throws ResourcesException;

    /**
     * Returns the height of the image. The method will block until the height
     * is available from the image.
     *
     * @return the height of the image in pixels.
     *
     * @throws ResourcesException
     *             if the loading of the resource is failed.
     *
     * @since 1.3
     */
    int getHeightPx() throws ResourcesException;

    /**
     * Returns the height of the image. The specified observer is notified when
     * the height is available.
     *
     * @param observer
     *            the {@link ImageObserver}.
     *
     * @return the height of the image in pixels.
     *
     * @throws ResourcesException
     *             if the loading of the resource is failed.
     *
     * @since 1.16
     */
    int getHeightPx(ImageObserver observer) throws ResourcesException;

    /**
     * Returns the width and height of the image. The method will block until
     * the height is available from the image.
     *
     * @return the {@link Dimension} containing the width and height of the
     *         image in pixels.
     *
     * @throws ResourcesException
     *             if the loading of the resource is failed.
     *
     * @since 1.3
     */
    Dimension getSizePx() throws ResourcesException;

    /**
     * Returns the width and height of the image. The method will block until
     * the height is available from the image.
     *
     * @param observer
     *            the {@link ImageObserver}.
     *
     * @return the {@link Dimension} containing the width and height of the
     *         image in pixels.
     *
     * @throws ResourcesException
     *             if the loading of the resource is failed.
     *
     * @since 1.16
     */
    Dimension getSizePx(ImageObserver observer) throws ResourcesException;

}