Classes

Class	Line #	Total Statements	Complexity	TOTAL Coverage	Actions
AlignCalcWorkerI	31	1	1	0.00%	Show methods

Class AlignCalcWorkerI

Class AlignCalcWorkerI	Line # 31	Total Statements 1	Complexity 1	TOTAL Coverage 0.00%
getCalcName() : String   getCalcName() : String	7272	1.01	1.01	0.0 0.00%

 

Contributing tests

Source view

1		/*
2		* Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3		* Copyright (C) $$Year-Rel$$ The Jalview Authors
4		*
5		* This file is part of Jalview.
6		*
7		* Jalview is free software: you can redistribute it and/or
8		* modify it under the terms of the GNU General Public License
9		* as published by the Free Software Foundation, either version 3
10		* of the License, or (at your option) any later version.
11		*
12		* Jalview is distributed in the hope that it will be useful, but
13		* WITHOUT ANY WARRANTY; without even the implied warranty
14		* of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15		* PURPOSE. See the GNU General Public License for more details.
16		*
17		* You should have received a copy of the GNU General Public License
18		* along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19		* The Jalview Authors are detailed in the 'AUTHORS' file.
20		*/
21		package jalview.api;
22
23		import java.util.concurrent.Callable;
24
25		import jalview.datamodel.AlignmentAnnotation;
26
27		/**
28		* Interface describing a worker that calculates alignment annotation(s). The
29		* main (re-)calculation should be performed by the inherited run() method.
30		*/
		0% Uncovered Elements: 2 (2) Complexity: 1 Complexity Density: 1
31		public interface AlignCalcWorkerI
32		{
33		/**
34		* Answers true if this worker updates the given annotation (regardless of its
35		* current state)
36		*
37		* @param annot
38		* @return
39		*/
40		boolean involves(AlignmentAnnotation annot);
41
42		/**
43		* Updates the display of calculated annotation values (does not recalculate
44		* the values). This allows a quick redraw of annotations when display
45		* settings are changed.
46		*/
47		void updateAnnotation();
48
49		/**
50		* Removes any annotation(s) managed by this worker from the alignment
51		*/
52		void removeAnnotation();
53
54		/**
55		* The main calculation happens here
56		* @throws Throwable
57		*/
58		public void run() throws Throwable;
59
60		/**
61		* Answers true if the worker should be deleted entirely when its annotation
62		* is deleted from the display, or false if it should continue to run. Some
63		* workers are required to run for their side-effects.
64		*
65		* @return
66		*/
67		boolean isDeletable();
68
69		/**
70		* Returns the name of this calculation.
71		*/
		0% Uncovered Elements: 1 (1) Complexity: 1 Complexity Density: 1
72	0	public default String getCalcName()...
73		{
74	0	return null;
75		}
76		}