1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.rendering.macro.descriptor

File ParameterDescriptor.java

 

Code metrics

0
0
0
1
72
13
0
-
-
0
-

Classes

Class Line # Actions
ParameterDescriptor 30 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.rendering.macro.descriptor;
21   
22    import java.lang.reflect.Type;
23   
24    /**
25    * Define a macro parameter.
26    *
27    * @version $Id: d4079c7a4cbdc55fd007d0f201dd16263a66b09f $
28    * @since 1.7M2
29    */
 
30    public interface ParameterDescriptor
31    {
32    /**
33    * @return the identifier of the parameter.
34    * @since 2.1M1
35    */
36    String getId();
37   
38    /**
39    * @return the display name of the parameter.
40    * @since 2.1M1
41    */
42    String getName();
43   
44    /**
45    * @return the description of the parameter.
46    */
47    String getDescription();
48   
49    /**
50    * @return the type of the parameter.
51    * @deprecated since 3.0M1 use {@link #getParameterType()} instead
52    */
53    @Deprecated
54    Class<?> getType();
55   
56    /**
57    * @return the type of the property.
58    * @since 3.0M1
59    */
60    Type getParameterType();
61   
62    /**
63    * @return the default value of the parameter.
64    */
65    Object getDefaultValue();
66   
67    /**
68    * @return indicate if the parameter is mandatory.
69    * @since 1.7
70    */
71    boolean isMandatory();
72    }