1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.formula

File ImageStorage.java

 

Code metrics

0
0
0
1
47
8
0
-
-
0
-

Classes

Class Line # Actions
ImageStorage 30 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.formula;
21   
22    import org.xwiki.component.annotation.Role;
23   
24    /**
25    * A component for storing generated images for later retrieval in a subsequent request.
26    *
27    * @version $Id: ea5d08bd500d8c21c776b77db901b88b48b2c680 $
28    */
29    @Role
 
30    public interface ImageStorage
31    {
32    /**
33    * Retrieve the image with the given identifier.
34    *
35    * @param id the identifier of the data in the storage
36    * @return an {@link ImageData} instance, or {@code null} if no image is stored under this identifier
37    */
38    ImageData get(String id);
39   
40    /**
41    * Store the image under the given identifier.
42    *
43    * @param id the identifier of the data in the storage
44    * @param data the image to be stored
45    */
46    void put(String id, ImageData data);
47    }