1. Project Clover database Fri Apr 29 2016 13:24:33 CEST
  2. Package info.magnolia.module.blossom.annotation

File TemplateParam.java

 

Code metrics

0
0
0
1
70
11
0
-
-
0
-

Classes

Class Line # Actions
TemplateParam 65 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /**
2    * This file Copyright (c) 2016 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    * Specifies a parameter on a template or an area, used in combination with the {@link TemplateParams} annotation.
43    * <p/>
44    * Example:
45    * <pre>
46    * &#64;TemplateParams({
47    * &#64;TemplateParam(name = "name1", value = "value1"),
48    * &#64;TemplateParam(name = "name2", value = "value2")
49    * })
50    * public class TemplateWithParameters {
51    * }
52    * </pre>
53    *
54    * Parameters can be used in template scripts as in this example:
55    * <pre>
56    * ${def.parameters.example!}
57    * </pre>
58    * A parameter overrides parameters specified in superclasses when they have the same name.
59    *
60    * @see TemplateParams
61    * @since 3.1.3
62    */
63    @Retention(RetentionPolicy.RUNTIME)
64    @Target(ElementType.TYPE)
 
65    public @interface TemplateParam {
66   
67    String name();
68   
69    String value();
70    }