Clover icon

Magnolia Imaging Module 3.2.3

  1. Project Clover database Fri Nov 6 2015 14:54:03 CET
  2. Package info.magnolia.imaging.operations

File ImageOperation.java

 

Code metrics

0
0
0
1
64
7
0
-
-
0
-

Classes

Class Line # Actions
ImageOperation 60 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /**
2    * This file Copyright (c) 2007-2015 Magnolia International
3    * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10    * This file is distributed in the hope that it will be
11    * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12    * implied warranty of MERCHANTABILITY or FITNESS FOR A
13    * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14    * Redistribution, except as permitted by whichever of the GPL
15    * or MNA you select, is prohibited.
16    *
17    * 1. For the GPL license (GPL), you can redistribute and/or
18    * modify this file under the terms of the GNU General
19    * Public License, Version 3, as published by the Free Software
20    * Foundation. You should have received a copy of the GNU
21    * General Public License, Version 3 along with this program;
22    * if not, write to the Free Software Foundation, Inc., 51
23    * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24    *
25    * 2. For the Magnolia Network Agreement (MNA), this file
26    * and the accompanying materials are made available under the
27    * terms of the MNA which accompanies this distribution, and
28    * is available at http://www.magnolia-cms.com/mna.html
29    *
30    * Any modifications to this file must keep this entire header
31    * intact.
32    *
33    */
34    package info.magnolia.imaging.operations;
35   
36    import info.magnolia.imaging.ImagingException;
37    import info.magnolia.imaging.ParameterProvider;
38   
39    import java.awt.image.BufferedImage;
40   
41    /**
42    * Applies any kind of filtering to an Image.
43    *
44    * TODO - the javadoc below is completely outdated.
45    * TODO - Image generation/filtering parameters can come from various places. We'll need to define how these are aggregated, if needed, etc.
46    *
47    * The filtering can be configured either by the end user or within the dialog definition.
48    * <ul>
49    * <li>filterParams, an arbitrary object converted to and from javascript by ImagesProcessor using JSON,
50    * represents the settings the user has chosen.</li>
51    * <li>dialogControlConfigNode is the node configuring the control in the dialog, which can have
52    * properties set to specific values by the dialog designer (i.e if we had a ColouringFilter, it could
53    * set some values to make sure that all images are turned into black/white)</li>
54    * </ul>
55    *
56    * @param <P> type of ParameterProvider
57    * @see info.magnolia.imaging.ImageGenerator
58    * @see java.awt.image.BufferedImageOp
59    */
 
60    public interface ImageOperation<P extends ParameterProvider<?>> {
61   
62    BufferedImage apply(BufferedImage source, P params) throws ImagingException;
63   
64    }