KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fop > image > ImageCache


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 /* $Id: ImageCache.java 426576 2006-07-28 15:44:37Z jeremias $ */
19  
20 package org.apache.fop.image;
21
22 // FOP
23 import org.apache.fop.apps.FOUserAgent;
24
25 /**
26  * Image cache holder.
27  * This interface is used for caching images.
28  */
29 public interface ImageCache {
30     
31     /**
32      * Get an image from the cache.
33      *
34      * @param url the url and key for the image
35      * @param context the user agent context
36      * @return the requested image
37      */
38     FopImage getImage(String JavaDoc url, FOUserAgent context);
39
40     /**
41      * Release an image in the current context.
42      *
43      * @param url the url and key for the image
44      * @param context the user agent context
45      */
46     void releaseImage(String JavaDoc url, FOUserAgent context);
47
48     /**
49      * Invalidate image.
50      * If during loading this image is found to be invalid
51      * it will be invalidated to prevent further attempts at
52      * loading the image.
53      *
54      * @param url the url and key for the image
55      * @param context the user agent context
56      */
57     void invalidateImage(String JavaDoc url, FOUserAgent context);
58
59     /**
60      * Remove a context and handle all images in the context.
61      *
62      * @param context the user agent context
63      */
64     void removeContext(FOUserAgent context);
65     
66     /**
67      * Forces the cache to fully cleared.
68      */
69     void clearAll();
70     
71 }
72
73
Popular Tags