Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
ParameterProviderFactory	59	0	-	0	0	-1.0 -	Show methods

Class ParameterProviderFactory

Class ParameterProviderFactory	Line # 59	Total Statements 0	% Filtered -	Complexity 0	Uncovered Elements 0	TOTAL Coverage -1.0 -

 

Contributing tests

Source view

1		/**
2		* This file Copyright (c) 2009-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;
35
36		import info.magnolia.imaging.caching.CachingStrategy;
37
38		/**
39		* A ParameterProviderFactory is responsible for instantiating a ParameterProvider
40		* for a given environment. Implementations know what concrete environment they expect and what
41		* concrete type of ParameterProvider they generate. The "environment" is likely to be
42		* an HttpServletRequest, but could also be a WorkItemContext, for instance.
43		*
44		* The ParameterProviderFactory must also ensure the parameter has appropriate
45		* equals() and hashCode() methods: the parameter is used as part of a key of a
46		* blocking map to avoid generating the same image multiple times.
47		*
48		* TODO -- verify, validate, fix the following :
49		* TODO -- The type of context basically depends on the caller. In most cases, the context (C)
50		* TODO -- will be an HttpServletRequest or a Magnolia Context instance.
51		* TODO -- Since the ParameterProviderFactory is provided by
52		* TODO -- the ImageGenerator, this might means that a particular ImageGenerator is tied
53		* TODO -- to a specific context.
54		*
55		* @param <E> type of the environment
56		* @param <PT> type of ParameterProvider's parameter
57		* @see info.magnolia.imaging.caching.ImageGenerationJob
58		*/
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
59		public interface ParameterProviderFactory<E, PT> {
60
61		/**
62		* Instantiates a new ParameterProvider for the given environment.
63		*/
64		ParameterProvider<PT> newParameterProviderFor(E environment);
65
66		CachingStrategy<PT> getCachingStrategy();
67
68		}