1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.rendering.internal.macro.chart

File ChartImageWriter.java

 

Code metrics

0
0
0
1
53
9
0
-
-
0
-

Classes

Class Line # Actions
ChartImageWriter 33 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.rendering.internal.macro.chart;
21   
22    import org.xwiki.component.annotation.Role;
23    import org.xwiki.rendering.macro.MacroExecutionException;
24   
25    /**
26    * Writes an Image represented as an array of Bytes to storage. Also provides a helper method to get an XWiki URL to
27    * access the written data.
28    *
29    * @version $Id: ecd194319dee5b4af87e16fca594d18502a9e8f8 $
30    * @since 4.2M3
31    */
32    @Role
 
33    public interface ChartImageWriter
34    {
35    /**
36    * Writes the image to storage.
37    *
38    * @param imageId the image id that we use to generate a unique storage location
39    * @param imageData the image to store
40    * @throws MacroExecutionException if an error happened when computing the location or saving the image
41    */
42    void writeImage(ImageId imageId, byte[] imageData) throws MacroExecutionException;
43   
44    /**
45    * Compute the URL to use to access the stored generate chart image.
46    *
47    * @param imageId the image id for the image that we have stored
48    * @return the URL to use to access the stored generate chart image
49    * @throws MacroExecutionException if an error happened when computing the URL (eg if the current wiki cannot be
50    * computed)
51    */
52    String getURL(ImageId imageId) throws MacroExecutionException;
53    }