Coverage Report

Coverage Report - org.owasp.dependencycheck.dependency.Evidence

Classes in this File

Line Coverage

Branch Coverage

Complexity

Evidence

68%

42/61

61%

21/34

2.389

 /*
  * This file is part of dependency-check-core.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  *
  * Copyright (c) 2012 Jeremy Long. All Rights Reserved.
  */
 package org.owasp.dependencycheck.dependency;
 
 import org.apache.commons.lang3.ObjectUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.builder.HashCodeBuilder;
 
 import java.io.Serializable;
 
 /**
  * Evidence is a piece of information about a Dependency.
  *
  * @author Jeremy Long
  */
 public class Evidence implements Serializable, Comparable<Evidence> {
 
     /**
      * The serial version UID for serialization.
      */
     private static final long serialVersionUID = 1L;
     /**
      * Used as starting point for generating the value in {@link #hashCode()}.
      */
     private static final int MAGIC_HASH_INIT_VALUE = 3;
 
     /**
      * Used as a multiplier for generating the value in {@link #hashCode()}.
      */
     private static final int MAGIC_HASH_MULTIPLIER = 67;
 
     /**
      * Creates a new Evidence object.
      */
     public Evidence() {
     }
 
     /**
      * Creates a new Evidence objects.
      *
      * @param source the source of the evidence.
      * @param name the name of the evidence.
      * @param value the value of the evidence.
      * @param confidence the confidence of the evidence.
      */
     public Evidence(String source, String name, String value, Confidence confidence) {
         this.source = source;
         this.name = name;
         this.value = value;
         this.confidence = confidence;
     }
 
     /**
      * The name of the evidence.
      */
     private String name;
 
     /**
      * Get the value of name.
      *
      * @return the value of name
      */
     public String getName() {
         return name;
     }
 
     /**
      * Set the value of name.
      *
      * @param name new value of name
      */
     public void setName(String name) {
         this.name = name;
     }
 
     /**
      * The source of the evidence.
      */
     private String source;
 
     /**
      * Get the value of source.
      *
      * @return the value of source
      */
     public String getSource() {
         return source;
     }
 
     /**
      * Set the value of source.
      *
      * @param source new value of source
      */
     public void setSource(String source) {
         this.source = source;
     }
 
     /**
      * The value of the evidence.
      */
     private String value;
 
     /**
      * Get the value of value.
      *
      * @return the value of value
      */
     public String getValue() {
         used = true;
         return value;
     }
 
     /**
      * Get the value of value. If setUsed is set to false this call to get will
      * not mark the evidence as used.
      *
      * @param setUsed whether or not this call to getValue should cause the used
      * flag to be updated
      * @return the value of value
      */
     public String getValue(Boolean setUsed) {
         used = used || setUsed;
         return value;
     }
 
     /**
      * Set the value of value.
      *
      * @param value new value of value
      */
     public void setValue(String value) {
         this.value = value;
     }
 
     /**
      * A value indicating if the Evidence has been "used" (aka read).
      */
     private boolean used;
 
     /**
      * Get the value of used.
      *
      * @return the value of used
      */
     public boolean isUsed() {
         return used;
     }
 
     /**
      * Set the value of used.
      *
      * @param used new value of used
      */
     public void setUsed(boolean used) {
         this.used = used;
     }
 
     /**
      * The confidence level for the evidence.
      */
     private Confidence confidence;
 
     /**
      * Get the value of confidence.
      *
      * @return the value of confidence
      */
     public Confidence getConfidence() {
         return confidence;
     }
 
     /**
      * Set the value of confidence.
      *
      * @param confidence new value of confidence
      */
     public void setConfidence(Confidence confidence) {
         this.confidence = confidence;
     }
 
     /**
      * Implements the hashCode for Evidence.
      *
      * @return hash code.
      */
     @Override
     public int hashCode() {
         return new HashCodeBuilder(MAGIC_HASH_INIT_VALUE, MAGIC_HASH_MULTIPLIER)
                 .append(StringUtils.lowerCase(name))
                 .append(StringUtils.lowerCase(source))
                 .append(StringUtils.lowerCase(value))
                 .append(confidence)
                 .toHashCode();
     }
 
     /**
      * Implements equals for Evidence.
      *
      * @param that an object to check the equality of.
      * @return whether the two objects are equal.
      */
     @SuppressWarnings("deprecation")
     @Override
     public boolean equals(Object that) {
         if (this == that) {
             return true;
         }
         if (!(that instanceof Evidence)) {
             return false;
         }
         final Evidence e = (Evidence) that;
 
         //TODO the call to ObjectUtils.equals needs to be replaced when we
         //stop supporting Jenkins 1.6 requirement.
         return StringUtils.equalsIgnoreCase(name, e.name)
                 && StringUtils.equalsIgnoreCase(source, e.source)
                 && StringUtils.equalsIgnoreCase(value, e.value)
                 && ObjectUtils.equals(confidence, e.confidence);
     }
 
     /**
      * Implementation of the comparable interface.
      *
      * @param o the evidence being compared
      * @return an integer indicating the ordering of the two objects
      */
     @SuppressWarnings("deprecation")
     @Override
     public int compareTo(Evidence o) {
         if (o == null) {
             return 1;
         }
         if (StringUtils.equalsIgnoreCase(source, o.source)) {
             if (StringUtils.equalsIgnoreCase(name, o.name)) {
                 if (StringUtils.equalsIgnoreCase(value, o.value)) {
                     //TODO the call to ObjectUtils.equals needs to be replaced when we
                     //stop supporting Jenkins 1.6 requirement.
                     if (ObjectUtils.equals(confidence, o.confidence)) {
                         return 0; //they are equal
                     } else {
                         return ObjectUtils.compare(confidence, o.confidence);
                     }
                 } else {
                     return compareToIgnoreCaseWithNullCheck(value, o.value);
                 }
             } else {
                 return compareToIgnoreCaseWithNullCheck(name, o.name);
             }
         } else {
             return compareToIgnoreCaseWithNullCheck(source, o.source);
         }
     }
 
     /**
      * Wrapper around
      * {@link java.lang.String#compareToIgnoreCase(java.lang.String) String.compareToIgnoreCase}
      * with an exhaustive, possibly duplicative, check against nulls.
      *
      * @param me the value to be compared
      * @param other the other value to be compared
      * @return true if the values are equal; otherwise false
      */
     private int compareToIgnoreCaseWithNullCheck(String me, String other) {
         if (me == null && other == null) {
             return 0;
         } else if (me == null) {
             return -1; //the other string is greater then me
         } else if (other == null) {
             return 1; //me is greater then the other string
         }
         return me.compareToIgnoreCase(other);
     }
 
     /**
      * Standard toString() implementation.
      *
      * @return the string representation of the object
      */
     @Override
     public String toString() {
         return "Evidence{" + "name=" + name + ", source=" + source + ", value=" + value + ", confidence=" + confidence + '}';
     }
 }

1		/*
2		* This file is part of dependency-check-core.
3		*
4		* Licensed under the Apache License, Version 2.0 (the "License");
5		* you may not use this file except in compliance with the License.
6		* You may obtain a copy of the License at
7		*
8		* http://www.apache.org/licenses/LICENSE-2.0
9		*
10		* Unless required by applicable law or agreed to in writing, software
11		* distributed under the License is distributed on an "AS IS" BASIS,
12		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13		* See the License for the specific language governing permissions and
14		* limitations under the License.
15		*
16		* Copyright (c) 2012 Jeremy Long. All Rights Reserved.
17		*/
18		package org.owasp.dependencycheck.dependency;
19
20		import org.apache.commons.lang3.ObjectUtils;
21		import org.apache.commons.lang3.StringUtils;
22		import org.apache.commons.lang3.builder.HashCodeBuilder;
23
24		import java.io.Serializable;
25
26		/**
27		* Evidence is a piece of information about a Dependency.
28		*
29		* @author Jeremy Long
30		*/
31	751	public class Evidence implements Serializable, Comparable<Evidence> {
32
33		/**
34		* The serial version UID for serialization.
35		*/
36		private static final long serialVersionUID = 1L;
37		/**
38		* Used as starting point for generating the value in {@link #hashCode()}.
39		*/
40		private static final int MAGIC_HASH_INIT_VALUE = 3;
41
42		/**
43		* Used as a multiplier for generating the value in {@link #hashCode()}.
44		*/
45		private static final int MAGIC_HASH_MULTIPLIER = 67;
46
47		/**
48		* Creates a new Evidence object.
49		*/
50	0	public Evidence() {
51	0	}
52
53		/**
54		* Creates a new Evidence objects.
55		*
56		* @param source the source of the evidence.
57		* @param name the name of the evidence.
58		* @param value the value of the evidence.
59		* @param confidence the confidence of the evidence.
60		*/
61	469	public Evidence(String source, String name, String value, Confidence confidence) {
62	468	this.source = source;
63	470	this.name = name;
64	470	this.value = value;
65	470	this.confidence = confidence;
66	469	}
67
68		/**
69		* The name of the evidence.
70		*/
71		private String name;
72
73		/**
74		* Get the value of name.
75		*
76		* @return the value of name
77		*/
78		public String getName() {
79	152	return name;
80		}
81
82		/**
83		* Set the value of name.
84		*
85		* @param name new value of name
86		*/
87		public void setName(String name) {
88	0	this.name = name;
89	0	}
90
91		/**
92		* The source of the evidence.
93		*/
94		private String source;
95
96		/**
97		* Get the value of source.
98		*
99		* @return the value of source
100		*/
101		public String getSource() {
102	522	return source;
103		}
104
105		/**
106		* Set the value of source.
107		*
108		* @param source new value of source
109		*/
110		public void setSource(String source) {
111	0	this.source = source;
112	0	}
113
114		/**
115		* The value of the evidence.
116		*/
117		private String value;
118
119		/**
120		* Get the value of value.
121		*
122		* @return the value of value
123		*/
124		public String getValue() {
125	455	used = true;
126	455	return value;
127		}
128
129		/**
130		* Get the value of value. If setUsed is set to false this call to get will
131		* not mark the evidence as used.
132		*
133		* @param setUsed whether or not this call to getValue should cause the used
134		* flag to be updated
135		* @return the value of value
136		*/
137		public String getValue(Boolean setUsed) {
138	92	used = used \|\| setUsed;
139	92	return value;
140		}
141
142		/**
143		* Set the value of value.
144		*
145		* @param value new value of value
146		*/
147		public void setValue(String value) {
148	0	this.value = value;
149	0	}
150
151		/**
152		* A value indicating if the Evidence has been "used" (aka read).
153		*/
154		private boolean used;
155
156		/**
157		* Get the value of used.
158		*
159		* @return the value of used
160		*/
161		public boolean isUsed() {
162	400	return used;
163		}
164
165		/**
166		* Set the value of used.
167		*
168		* @param used new value of used
169		*/
170		public void setUsed(boolean used) {
171	0	this.used = used;
172	0	}
173
174		/**
175		* The confidence level for the evidence.
176		*/
177		private Confidence confidence;
178
179		/**
180		* Get the value of confidence.
181		*
182		* @return the value of confidence
183		*/
184		public Confidence getConfidence() {
185	256	return confidence;
186		}
187
188		/**
189		* Set the value of confidence.
190		*
191		* @param confidence new value of confidence
192		*/
193		public void setConfidence(Confidence confidence) {
194	0	this.confidence = confidence;
195	0	}
196
197		/**
198		* Implements the hashCode for Evidence.
199		*
200		* @return hash code.
201		*/
202		@Override
203		public int hashCode() {
204	12	return new HashCodeBuilder(MAGIC_HASH_INIT_VALUE, MAGIC_HASH_MULTIPLIER)
205	6	.append(StringUtils.lowerCase(name))
206	6	.append(StringUtils.lowerCase(source))
207	6	.append(StringUtils.lowerCase(value))
208	6	.append(confidence)
209	6	.toHashCode();
210		}
211
212		/**
213		* Implements equals for Evidence.
214		*
215		* @param that an object to check the equality of.
216		* @return whether the two objects are equal.
217		*/
218		@SuppressWarnings("deprecation")
219		@Override
220		public boolean equals(Object that) {
221	10	if (this == that) {
222	0	return true;
223		}
224	10	if (!(that instanceof Evidence)) {
225	0	return false;
226		}
227	10	final Evidence e = (Evidence) that;
228
229		//TODO the call to ObjectUtils.equals needs to be replaced when we
230		//stop supporting Jenkins 1.6 requirement.
231	20	return StringUtils.equalsIgnoreCase(name, e.name)
232	2	&& StringUtils.equalsIgnoreCase(source, e.source)
233	2	&& StringUtils.equalsIgnoreCase(value, e.value)
234	2	&& ObjectUtils.equals(confidence, e.confidence);
235		}
236
237		/**
238		* Implementation of the comparable interface.
239		*
240		* @param o the evidence being compared
241		* @return an integer indicating the ordering of the two objects
242		*/
243		@SuppressWarnings("deprecation")
244		@Override
245		public int compareTo(Evidence o) {
246	763	if (o == null) {
247	0	return 1;
248		}
249	763	if (StringUtils.equalsIgnoreCase(source, o.source)) {
250	456	if (StringUtils.equalsIgnoreCase(name, o.name)) {
251	244	if (StringUtils.equalsIgnoreCase(value, o.value)) {
252		//TODO the call to ObjectUtils.equals needs to be replaced when we
253		//stop supporting Jenkins 1.6 requirement.
254	219	if (ObjectUtils.equals(confidence, o.confidence)) {
255	217	return 0; //they are equal
256		} else {
257	2	return ObjectUtils.compare(confidence, o.confidence);
258		}
259		} else {
260	25	return compareToIgnoreCaseWithNullCheck(value, o.value);
261		}
262		} else {
263	215	return compareToIgnoreCaseWithNullCheck(name, o.name);
264		}
265		} else {
266	304	return compareToIgnoreCaseWithNullCheck(source, o.source);
267		}
268		}
269
270		/**
271		* Wrapper around
272		* {@link java.lang.String#compareToIgnoreCase(java.lang.String) String.compareToIgnoreCase}
273		* with an exhaustive, possibly duplicative, check against nulls.
274		*
275		* @param me the value to be compared
276		* @param other the other value to be compared
277		* @return true if the values are equal; otherwise false
278		*/
279		private int compareToIgnoreCaseWithNullCheck(String me, String other) {
280	542	if (me == null && other == null) {
281	0	return 0;
282	542	} else if (me == null) {
283	0	return -1; //the other string is greater then me
284	544	} else if (other == null) {
285	0	return 1; //me is greater then the other string
286		}
287	543	return me.compareToIgnoreCase(other);
288		}
289
290		/**
291		* Standard toString() implementation.
292		*
293		* @return the string representation of the object
294		*/
295		@Override
296		public String toString() {
297	0	return "Evidence{" + "name=" + name + ", source=" + source + ", value=" + value + ", confidence=" + confidence + '}';
298		}
299		}