org.apache.xmlgraphics.image.loader.Image Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* $Id: Image.java 750418 2009-03-05 11:03:54Z vhennebert $ */
package org.apache.xmlgraphics.image.loader;
import java.awt.color.ColorSpace;
import java.awt.color.ICC_Profile;
/**
* Represents an instance of an image (bitmap or vector graphic). The image may or may not be loaded
* into memory. Implementing classes will expose additional methods to access the actual image data.
*/
public interface Image {
/**
* Returns an object with basic information (URI, MIME type, intrinsic size) about the image.
* @return the image information object
*/
ImageInfo getInfo();
/**
* Returns the image's intrinsic size. This is a shortcut for getInfo().getSize().
* @return the image's intrinsic size
*/
ImageSize getSize();
/**
* Returns the flavor of the image.
* @return the image flavor
*/
ImageFlavor getFlavor();
/**
* Indicates whether the Image instance is cacheable in memory.
* @return true if the Image is cacheable
*/
boolean isCacheable();
/**
* Returns the ICC color profile if one is associated with the image.
* @return the ICC color profile or null if there's no profile
*/
ICC_Profile getICCProfile();
/**
* Returns the image's color space if the information is available.
* @return the color space or null if the color space is unknown or undefined
*/
ColorSpace getColorSpace();
}