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

File FilterStreamPropertyDescriptor.java

 

Code metrics

0
0
0
1
61
11
0
-
-
0
-

Classes

Class Line # Actions
FilterStreamPropertyDescriptor 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.filter.descriptor;
21   
22    import java.lang.reflect.Type;
23   
24    /**
25    * Defines a filter property.
26    *
27    * @version $Id: 96b9d4b6b212f96b1fac56510abc73ff2c233513 $
28    * @since 6.2M1
29    */
 
30    public interface FilterStreamPropertyDescriptor<T>
31    {
32    /**
33    * @return the identifier of the property.
34    */
35    String getId();
36   
37    /**
38    * @return the display name of the property.
39    */
40    String getName();
41   
42    /**
43    * @return the description of the property.
44    */
45    String getDescription();
46   
47    /**
48    * @return the type of the property.
49    */
50    Type getType();
51   
52    /**
53    * @return the default value of the property.
54    */
55    T getDefaultValue();
56   
57    /**
58    * @return indicate if the property is mandatory.
59    */
60    boolean isMandatory();
61    }