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

File Available.java

 

Code metrics

0
0
0
1
71
9
0
-
-
0
-

Classes

Class Line # Actions
Available 69 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /**
2    * This file Copyright (c) 2010-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    * Declares a method as being responsible for deciding if a template can be used on a specific page.
43    * <p/>
44    * The method can accept arguments of types:
45    * <ul>
46    * <li>{@link javax.jcr.Node}
47    * <li>{@link info.magnolia.cms.core.Content}
48    * <li>{@link info.magnolia.rendering.template.TemplateDefinition} which is the template definition of the current template
49    * <li>{@link info.magnolia.context.WebContext}
50    * <li>{@link info.magnolia.context.Context}
51    * <li>{@link info.magnolia.cms.security.User}
52    * <li>{@link info.magnolia.cms.security.MgnlUser}
53    * </ul>
54    * The method must return boolean and should not throw a checked exception. If defined in a super class the method will
55    * be detected and used.
56    * <p/>
57    * For example:
58    * <pre>
59    * &#064;Available
60    * public boolean isAvailable(Node node, TemplateDefinition templateDefinition) { ... }
61    * </pre>
62    *
63    * @see info.magnolia.module.blossom.annotation.Template
64    * @see info.magnolia.cms.core.Content
65    * @since 1.1.1
66    */
67    @Retention(RetentionPolicy.RUNTIME)
68    @Target(ElementType.METHOD)
 
69    public @interface Available {
70   
71    }