1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package org.xwiki.velocity

File VelocityConfiguration.java

 

Code metrics

0
0
0
1
50
9
0
-
-
0
-

Classes

Class Line # Actions
VelocityConfiguration 37 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.velocity;
21   
22    import java.util.Properties;
23   
24    import org.xwiki.component.annotation.Role;
25   
26    /**
27    * Configuration properties for the Velocity module.
28    * <p>
29    * You can override the default values for each of the configuration properties below by defining them in XWiki's
30    * global configuration file using a prefix of "velocity" followed by the property name. For example:
31    * <code>velocity.tools = listtool = org.apache.velocity.tools.generic.ListTool</code>
32    *
33    * @version $Id: b9a847aa9e0f5dd3f0993719ec1babc6e4cd5cd7 $
34    * @since 2.0M1
35    */
36    @Role
 
37    public interface VelocityConfiguration
38    {
39    /**
40    * @return the Velocity properties as defined at
41    * http://velocity.apache.org/engine/devel/developer-guide.html#Velocity_Configuration_Keys_and_Values
42    */
43    Properties getProperties();
44   
45    /**
46    * @return the list of configured Velocity Tools (the key is the name under which the tool will be available
47    * in the Velocity Context and the value is the tool's class name)
48    */
49    Properties getTools();
50    }