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

File ScriptServiceManager.java

 

Code metrics

0
0
0
1
43
7
0
-
-
0
-

Classes

Class Line # Actions
ScriptServiceManager 32 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.script.service;
21   
22    import org.xwiki.component.annotation.Role;
23   
24    /**
25    * Provides access to {@link ScriptService} implementation at runtime. Implementations of this interface are supposed to
26    * be bound to the Script Context so that they can be access from scripts.
27    *
28    * @version $Id: 2139e5c7d4d7d6fe0932e2f999c65bc00479937d $
29    * @since 2.3M1
30    */
31    @Role
 
32    public interface ScriptServiceManager
33    {
34    /**
35    * Note that we're voluntarily using an API name of "get" to make it extra easy to access Script Services from
36    * Velocity (since in Velocity writing <code>$services.name</code> is equivalent to writing
37    * <code>$services.get("name")</code>). It also makes it a short and easy API name for other scripting languages.
38    *
39    * @param serviceName the name of the service to look for
40    * @return the service asked or null if none could be found
41    */
42    ScriptService get(String serviceName);
43    }