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

File GroupedJob.java

 

Code metrics

0
0
0
1
44
5
0
-
-
0
-

Classes

Class Line # Actions
GroupedJob 38 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.job;
21   
22    /**
23    * A Job which is part of a group of jobs. Grouped jobs are executed synchronously usually in the same thread.
24    * <p>
25    * The {@link GroupedJob} return a group hierarchy interpreted as follow:
26    * <ul>
27    * <li>a {@link GroupedJob} from group ["group", "subgroup"] won't be executed at the same time of another
28    * {@link GroupedJob} from group ["group", "subgroup"]
29    * <li>a {@link GroupedJob} from group ["group", "subgroup1"] can be executed at the same time of a {@link GroupedJob}
30    * from group ["group", "subgroup2"]
31    * <li>a {@link GroupedJob} from group ["group", "subgroup"] won't be executed at the same time of a {@link GroupedJob}
32    * from group ["group"]
33    * </ul>
34    *
35    * @version $Id: c3d6abf2c2018cf43ccf8120e26cfce399e25a39 $
36    * @since 6.1M2
37    */
 
38    public interface GroupedJob extends Job
39    {
40    /**
41    * @return the group hierarchy of the job. If null the job won't be grouped.
42    */
43    JobGroupPath getGroupPath();
44    }