Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
JobProgressStep	32	0	-	0	0	-1.0 -	Show methods

Class JobProgressStep

Class JobProgressStep	Line # 32	Total Statements 0	% Filtered -	Complexity 0	Uncovered Elements 0	TOTAL Coverage -1.0 -

 

Contributing tests

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.event.status;
21
22		import java.util.List;
23
24		import org.xwiki.logging.Message;
25
26		/**
27		* Represents one step in the progress tree.
28		*
29		* @version $Id: 0363c176be0aa474ac52c3b0e96864d15b8ea9c9 $
30		* @since 7.1M2
31		*/
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
32		public interface JobProgressStep
33		{
34		/**
35		* @return the message associated to the step, can be null
36		*/
37		Message getMessage();
38
39		/**
40		* @return the parent step
41		*/
42		JobProgressStep getParent();
43
44		/**
45		* @param <S> the type of the step
46		* @return the children steps
47		*/
48		<S extends JobProgressStep> List<S> getChildren();
49
50		/**
51		* @return progress of the current step between 0 and 1
52		*/
53		double getOffset();
54
55		/**
56		* @return the time spend executing the step, in nanoseconds
57		*/
58		long getElapsedTime();
59		}