//
// Copyright (C) 2012 United States Government as represented by the
// Administrator of the National Aeronautics and Space Administration
// (NASA). All Rights Reserved.
//
// This software is distributed under the NASA Open Source Agreement
// (NOSA), version 1.3. The NOSA has been approved by the Open Source
// Initiative. See the file NOSA-1.3-JPF at the top of the distribution
// directory tree for the complete NOSA document.
//
// THE SUBJECT SOFTWARE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY OF ANY
// KIND, EITHER EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT
// LIMITED TO, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL CONFORM TO
// SPECIFICATIONS, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR
// A PARTICULAR PURPOSE, OR FREEDOM FROM INFRINGEMENT, ANY WARRANTY THAT
// THE SUBJECT SOFTWARE WILL BE ERROR FREE, OR ANY WARRANTY THAT
// DOCUMENTATION, IF PROVIDED, WILL CONFORM TO THE SUBJECT SOFTWARE.
//
package gov.nasa.jpf.conformanceChecker.checkers;
import gov.nasa.jpf.conformanceChecker.Inconsistency;
import gov.nasa.jpf.conformanceChecker.Inconsistency.InconsistencyType;
import gov.nasa.jpf.conformanceChecker.comparators.MethodInfoComparator;
import gov.nasa.jpf.conformanceChecker.providers.ProviderFactory;
import gov.nasa.jpf.conformanceChecker.providers.StandardClassProvider;
import gov.nasa.jpf.conformanceChecker.reporters.Reporter;
import gov.nasa.jpf.conformanceChecker.util.MaybeVersion;
import gov.nasa.jpf.jvm.ClassInfo;
import gov.nasa.jpf.jvm.MethodInfo;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
/**
* This class checks for methods present in the standard version of the class
* but missing in its model.
*
* @see InconsistencyType#MISSING_METHOD
*
* @author Matteo Ceccarello <matteo.ceccarello AT gmail.com>
*
*/
public class MissingMethodChecker extends Checker {
MethodInfoComparator comparator = new MethodInfoComparator();
StandardClassProvider provider;
public MissingMethodChecker() {
super();
this.provider = ProviderFactory.getStandardProvider();;
}
public MissingMethodChecker(List<Reporter> reporters) {
super(reporters);
this.provider = ProviderFactory.getStandardProvider();
}
public MissingMethodChecker(List<Reporter> reporters, MemberLevel level) {
super(reporters, level);
this.provider = ProviderFactory.getStandardProvider();
}
@Override
public boolean check(ClassInfo cls) {
Map<MaybeVersion, ClassInfo> standardVersions = provider.loadClassInfo(cls.getName());
boolean noInconsistencies = true;
// TODO see if it's better to work on copies
MethodInfo[] modelMethods = cls.getDeclaredMethodInfos();
Arrays.sort(modelMethods, comparator);
for (MaybeVersion version : standardVersions.keySet()) {
MethodInfo[] standardMethods = standardVersions.get(version).getDeclaredMethodInfos();
for (MethodInfo m : standardMethods) {
if(MemberLevel.getMemberLevel(m).compareTo(this.level) >= 0) {
if(Arrays.binarySearch(modelMethods, m, comparator) < 0) {
signal(new Inconsistency(
InconsistencyType.MISSING_METHOD,
version,
m.getClassInfo(),
m,
"This method is present in the library version " +
"but missing in the model."));
noInconsistencies = false;
}
}
}
}
return noInconsistencies;
}
}