Classes

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

Class PreRegister

Class PreRegister	Line # 84	Total Statements 0	% Filtered -	Complexity 0	Uncovered Elements 0	TOTAL Coverage -1.0 -

 

Contributing tests

Source view

1		/**
2		* This file Copyright (c) 2010-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.module.blossom.annotation;
35
36		import java.lang.annotation.ElementType;
37		import java.lang.annotation.Retention;
38		import java.lang.annotation.RetentionPolicy;
39		import java.lang.annotation.Target;
40
41		/**
42		* Declares a method to be called prior to registration of a template, area or dialog. The method must take exactly one
43		* argument and its type depends on what is being registered. The method can optionally have a return type in which case
44		* the return value is fed into registration callbacks in the sub class. If the callback returns null registration is
45		* aborted.
46		*
47		* <h2>Templates</h2>
48		* To receive a callback when a template is registered declare the method with an argument of type
49		* {@link info.magnolia.rendering.template.TemplateDefinition} or {@link info.magnolia.module.blossom.template.BlossomTemplateDefinition}.
50		* <p/>
51		* For example:
52		* <pre>
53		* &#064;PreRegister
54		* public void register(BlossomTemplateDefinition templateDefinition) {
55		* }
56		* </pre>
57		* <h2>Areas</h2>
58		* To receive a callback when an area is registered declare the method with an argument of type
59		* {@link info.magnolia.rendering.template.AreaDefinition} or {@link info.magnolia.module.blossom.template.BlossomAreaDefinition}.
60		* <p/>
61		* For example:
62		* <pre>
63		* &#064;PreRegister
64		* public void register(BlossomAreaDefinition areaDefinition) {
65		* }
66		* </pre>
67		* <h2>Dialogs</h2>
68		* To receive a callback when a dialog is registered declare the method with an argument of type {@link info.magnolia.module.blossom.dialog.BlossomDialogDescription}.
69		* <p/>
70		* For example:
71		* <pre>
72		* &#064;PreRegister
73		* public void register(BlossomDialogDescription dialogDescription) {
74		* }
75		* </pre>
76		*
77		* @see Area
78		* @see Template
79		* @see DialogFactory
80		* @since 3.0.2
81		*/
82		@Retention(RetentionPolicy.RUNTIME)
83		@Target(ElementType.METHOD)
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
84		public @interface PreRegister {
85
86		}