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

File GroovyCompilationCustomizer.java

 

Code metrics

0
0
0
1
46
8
0
-
-
0
-

Classes

Class Line # Actions
GroovyCompilationCustomizer 40 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.groovy;
21   
22    import org.codehaus.groovy.control.customizers.CompilationCustomizer;
23    import org.xwiki.component.annotation.Role;
24   
25    /**
26    * Allow providing Groovy's {@link CompilationCustomizer}s to perform Groovy customization such as: automatically add
27    * imports, stop script execution after a certain timeout, prevents using some imports/statements/operators/etc, and
28    * more.
29    * <p>
30    * Note that we would have liked to not have this interface and instead have our component implementations directly
31    * implement {@link CompilationCustomizer} but unfortunately the Groovy guys made the choice(wrong, IMO) to not use an
32    * interface for CompilationCustomizer; it's an Abstract class! (yuck, even the name is wrong since a good practice is
33    * to have Abstract in the name of Abstract classes...).
34    * </p>
35    *
36    * @version $Id: 5cb525d446c6fd29cadcce837a309c07afc832ea $
37    * @since 4.1M1
38    */
39    @Role
 
40    public interface GroovyCompilationCustomizer
41    {
42    /**
43    * @return the Groovy Customizer implementation class to use. If null is returned then no customizer will be added
44    */
45    CompilationCustomizer createCustomizer();
46    }