From 6a8ddc22378fcc984ae40e5451ade635945ca70e Mon Sep 17 00:00:00 2001 From: Evgeny Mandrikov Date: Tue, 5 Apr 2011 02:23:53 +0400 Subject: [PATCH] Fix violations --- .../api/batch/AbstractSourceImporter.java | 10 +++++----- .../main/java/org/sonar/api/batch/Event.java | 9 ++++++++- .../org/sonar/api/batch/SensorContext.java | 1 - .../java/org/sonar/api/measures/Metric.java | 2 ++ .../org/sonar/api/resources/JavaPackage.java | 6 +++--- .../java/org/sonar/api/resources/Project.java | 4 ++-- .../sonar/api/resources/ResourceUtils.java | 20 +++++++++---------- .../java/org/sonar/api/utils/DateUtils.java | 11 ++++++---- .../java/org/sonar/api/utils/ZipUtils.java | 2 +- .../main/java/org/sonar/test/TestUtils.java | 18 +++++++++++------ .../sonar/test/channel/ChannelMatchers.java | 5 ++++- .../org/sonar/wsclient/services/Measure.java | 1 + 12 files changed, 55 insertions(+), 34 deletions(-) diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/batch/AbstractSourceImporter.java b/sonar-plugin-api/src/main/java/org/sonar/api/batch/AbstractSourceImporter.java index 8adbf97d8ed..88d7db41dee 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/batch/AbstractSourceImporter.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/batch/AbstractSourceImporter.java @@ -31,23 +31,23 @@ import java.util.List; /** * A pre-implementation for a sensor that imports sources - * + * * @since 1.10 */ @Phase(name = Phase.Name.PRE) public abstract class AbstractSourceImporter implements Sensor { /** - * @deprecated replaced by CoreProperties.CORE_IMPORT_SOURCES_PROPERTY since 1.11 + * @deprecated in 1.11. Use {@link CoreProperties#CORE_IMPORT_SOURCES_PROPERTY} instead. */ @Deprecated - public static final String KEY_IMPORT_SOURCES = "sonar.importSources"; + public static final String KEY_IMPORT_SOURCES = CoreProperties.CORE_IMPORT_SOURCES_PROPERTY; /** - * @deprecated replaced by CoreProperties.CORE_IMPORT_SOURCES_DEFAULT_VALUE since 1.11 + * @deprecated in 1.11. Use {@link CoreProperties#CORE_IMPORT_SOURCES_DEFAULT_VALUE} instead. */ @Deprecated - public static final boolean DEFAULT_IMPORT_SOURCES = true; + public static final boolean DEFAULT_IMPORT_SOURCES = CoreProperties.CORE_IMPORT_SOURCES_DEFAULT_VALUE; private Language language; diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/batch/Event.java b/sonar-plugin-api/src/main/java/org/sonar/api/batch/Event.java index 99fa3aa5b30..b1a7f1e19b9 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/batch/Event.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/batch/Event.java @@ -23,9 +23,10 @@ import org.apache.commons.lang.builder.ToStringBuilder; import org.sonar.api.database.BaseIdentifiable; import org.sonar.api.database.model.Snapshot; -import javax.persistence.*; import java.util.Date; +import javax.persistence.*; + /** * @since 1.10 */ @@ -69,6 +70,9 @@ public class Event extends BaseIdentifiable { this.category = category; } + /** + * @deprecated in 2.5 + */ @Deprecated public Event(String name, String description, String category, Date date, Integer resourceId) { this.name = name; @@ -78,6 +82,9 @@ public class Event extends BaseIdentifiable { this.resourceId = resourceId; } + /** + * @deprecated in 2.5 + */ @Deprecated public Event(String name, String description, String category, Snapshot snapshot) { this.name = name; diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/batch/SensorContext.java b/sonar-plugin-api/src/main/java/org/sonar/api/batch/SensorContext.java index 8f09a59e68f..811c7ff7a0a 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/batch/SensorContext.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/batch/SensorContext.java @@ -23,7 +23,6 @@ import org.sonar.api.design.Dependency; import org.sonar.api.measures.Measure; import org.sonar.api.measures.MeasuresFilter; import org.sonar.api.measures.Metric; -import org.sonar.api.resources.DuplicatedSourceException; import org.sonar.api.resources.ProjectLink; import org.sonar.api.resources.Resource; import org.sonar.api.rules.Violation; diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/measures/Metric.java b/sonar-plugin-api/src/main/java/org/sonar/api/measures/Metric.java index 744543e614e..a26fe7a481a 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/measures/Metric.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/measures/Metric.java @@ -122,6 +122,8 @@ public class Metric implements ServerExtension, BatchExtension { /** * Creates an empty metric + * + * @deprecated in 1.12 */ @Deprecated public Metric() { diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/resources/JavaPackage.java b/sonar-plugin-api/src/main/java/org/sonar/api/resources/JavaPackage.java index 7da6eb3f800..9587b0937f4 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/resources/JavaPackage.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/resources/JavaPackage.java @@ -35,7 +35,7 @@ public class JavaPackage extends Resource { public static final String DEFAULT_PACKAGE_NAME = "[default]"; /** - * Defaul constructor + * Default constructor */ public JavaPackage() { this(null); @@ -49,7 +49,7 @@ public class JavaPackage extends Resource { } /** - * @return whether the JavaPackage key is the defult key + * @return whether the JavaPackage key is the default key */ public boolean isDefault() { return StringUtils.equals(getKey(), DEFAULT_PACKAGE_NAME); @@ -73,7 +73,7 @@ public class JavaPackage extends Resource { * @return SCOPE_SPACE */ public String getScope() { - return Resource.SCOPE_SPACE; + return Scopes.DIRECTORY; } /** diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/resources/Project.java b/sonar-plugin-api/src/main/java/org/sonar/api/resources/Project.java index ac692d1d268..c7eb9c41600 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/resources/Project.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/resources/Project.java @@ -281,14 +281,14 @@ public class Project extends Resource { * @return the scope of the current object */ public String getScope() { - return SCOPE_SET; + return Scopes.PROJECT; } /** * @return the qualifier of the current object */ public String getQualifier() { - return isRoot() ? QUALIFIER_PROJECT : QUALIFIER_MODULE; + return isRoot() ? Qualifiers.PROJECT : Qualifiers.MODULE; } @Override diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/resources/ResourceUtils.java b/sonar-plugin-api/src/main/java/org/sonar/api/resources/ResourceUtils.java index 8f55f874743..aa80f222395 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/resources/ResourceUtils.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/resources/ResourceUtils.java @@ -33,56 +33,56 @@ public final class ResourceUtils { * @return whether the resource is a view */ public static boolean isView(Resource resource) { - return isSet(resource) && Resource.QUALIFIER_VIEW.equals(resource.getQualifier()); + return isSet(resource) && Qualifiers.VIEW.equals(resource.getQualifier()); } /** * @return whether the resource is a subview (in the view tree) */ public static boolean isSubview(Resource resource) { - return isSet(resource) && Resource.QUALIFIER_SUBVIEW.equals(resource.getQualifier()); + return isSet(resource) && Qualifiers.SUBVIEW.equals(resource.getQualifier()); } /** * @return whether the resource is the root project */ public static boolean isRootProject(Resource resource) { - return Resource.QUALIFIER_PROJECT.equals(resource.getQualifier()); + return Qualifiers.PROJECT.equals(resource.getQualifier()); } /** * @return whether a resource is a maven module of project */ public static boolean isModuleProject(Resource resource) { - return Resource.QUALIFIER_MODULE.equals(resource.getQualifier()); + return Qualifiers.MODULE.equals(resource.getQualifier()); } /** * @return whether a resource is a package */ public static boolean isPackage(Resource resource) { - return resource != null && Resource.QUALIFIER_PACKAGE.equals(resource.getQualifier()); + return resource != null && Qualifiers.PACKAGE.equals(resource.getQualifier()); } /** * @return whether a resource is a set */ public static boolean isSet(Resource resource) { - return resource != null && Resource.SCOPE_SET.equals(resource.getScope()); + return resource != null && Scopes.PROJECT.equals(resource.getScope()); } /** * @return whether a resource is a space */ public static boolean isSpace(Resource resource) { - return resource != null && Resource.SCOPE_SPACE.equals(resource.getScope()); + return resource != null && Scopes.DIRECTORY.equals(resource.getScope()); } /** * @return whether a resource is an entity. */ public static boolean isEntity(Resource resource) { - return resource != null && Resource.SCOPE_ENTITY.equals(resource.getScope()); + return resource != null && Scopes.FILE.equals(resource.getScope()); } /** @@ -112,7 +112,7 @@ public final class ResourceUtils { * @return whether a resource is a class */ public static boolean isClass(Resource resource) { - return Resource.QUALIFIER_CLASS.equals(resource.getQualifier()); + return Qualifiers.CLASS.equals(resource.getQualifier()); } /** @@ -126,7 +126,7 @@ public final class ResourceUtils { * @return whether a resource is a library */ public static boolean isLibrary(Resource resource) { - return Resource.QUALIFIER_LIB.equals(resource.getQualifier()); + return Qualifiers.LIBRARY.equals(resource.getQualifier()); } /** diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/utils/DateUtils.java b/sonar-plugin-api/src/main/java/org/sonar/api/utils/DateUtils.java index d3b431ae076..4a072719622 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/utils/DateUtils.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/utils/DateUtils.java @@ -27,7 +27,7 @@ import java.util.Date; /** * Parses and formats ISO 8601 dates. See http://en.wikipedia.org/wiki/ISO_8601. * This class is thread-safe. - * + * * @since 2.7 */ public final class DateUtils { @@ -37,6 +37,9 @@ public final class DateUtils { private static final ThreadSafeDateFormat dateFormat = new ThreadSafeDateFormat(DATE_FORMAT); private static final ThreadSafeDateFormat dateTimeFormat = new ThreadSafeDateFormat(DATETIME_FORMAT); + private DateUtils() { + } + public static String formatDate(Date d) { return dateFormat.format(d); } @@ -72,7 +75,7 @@ public final class DateUtils { private final transient ThreadLocal cache = new ThreadLocal() { public Object get() { - Reference softRef = (Reference)super.get(); + Reference softRef = (Reference) super.get(); if (softRef == null || softRef.get() == null) { softRef = new SoftReference(new SimpleDateFormat(format)); super.set(softRef); @@ -82,10 +85,10 @@ public final class DateUtils { }; private DateFormat getDateFormat() { - return (DateFormat) ((Reference)cache.get()).get(); + return (DateFormat) ((Reference) cache.get()).get(); } - public StringBuffer format(Date date,StringBuffer toAppendTo, FieldPosition fieldPosition) { + public StringBuffer format(Date date, StringBuffer toAppendTo, FieldPosition fieldPosition) { return getDateFormat().format(date, toAppendTo, fieldPosition); } diff --git a/sonar-plugin-api/src/main/java/org/sonar/api/utils/ZipUtils.java b/sonar-plugin-api/src/main/java/org/sonar/api/utils/ZipUtils.java index a4d107347a5..ef8703eb66a 100644 --- a/sonar-plugin-api/src/main/java/org/sonar/api/utils/ZipUtils.java +++ b/sonar-plugin-api/src/main/java/org/sonar/api/utils/ZipUtils.java @@ -157,7 +157,7 @@ public final class ZipUtils { } } - public static interface ZipEntryFilter { + public interface ZipEntryFilter { boolean accept(ZipEntry entry); } diff --git a/sonar-testing-harness/src/main/java/org/sonar/test/TestUtils.java b/sonar-testing-harness/src/main/java/org/sonar/test/TestUtils.java index a5cb54aa487..042f5865024 100644 --- a/sonar-testing-harness/src/main/java/org/sonar/test/TestUtils.java +++ b/sonar-testing-harness/src/main/java/org/sonar/test/TestUtils.java @@ -19,6 +19,11 @@ */ package org.sonar.test; +import static org.hamcrest.core.Is.is; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertThat; +import static org.junit.Assert.assertTrue; + import org.apache.commons.io.FileUtils; import org.apache.commons.lang.CharEncoding; import org.apache.commons.lang.CharUtils; @@ -32,15 +37,15 @@ import java.io.File; import java.io.IOException; import java.net.URL; -import static org.hamcrest.core.Is.is; -import static org.junit.Assert.*; - /** * Utilities for unit tests * * @since 2.2 */ -public class TestUtils { +public final class TestUtils { + + private TestUtils() { + } /** * Search for a test resource in the classpath. For example getResource("org/sonar/MyClass/foo.txt"); @@ -50,7 +55,7 @@ public class TestUtils { */ public static File getResource(String path) { String resourcePath = path; - if ( !resourcePath.startsWith("/")) { + if (!resourcePath.startsWith("/")) { resourcePath = "/" + resourcePath; } URL url = TestUtils.class.getResource(resourcePath); @@ -81,7 +86,7 @@ public class TestUtils { */ public static File getResource(Class baseClass, String path) { String resourcePath = StringUtils.replaceChars(baseClass.getCanonicalName(), '.', '/'); - if ( !path.startsWith("/")) { + if (!path.startsWith("/")) { resourcePath += "/"; } resourcePath += path; @@ -97,6 +102,7 @@ public class TestUtils { /** * Create a temporary directory for unit tests. + * * @param baseClass the unit test class * @param testName the test name * @param clean remove all the sub-directories and files ? diff --git a/sonar-testing-harness/src/main/java/org/sonar/test/channel/ChannelMatchers.java b/sonar-testing-harness/src/main/java/org/sonar/test/channel/ChannelMatchers.java index b434cefe23a..c95f7cc99a7 100644 --- a/sonar-testing-harness/src/main/java/org/sonar/test/channel/ChannelMatchers.java +++ b/sonar-testing-harness/src/main/java/org/sonar/test/channel/ChannelMatchers.java @@ -21,7 +21,10 @@ package org.sonar.test.channel; import org.sonar.channel.CodeReader; -public class ChannelMatchers { +public final class ChannelMatchers { + + private ChannelMatchers() { + } public static ChannelMatcher consume(String sourceCode, OUTPUT output) { return new ChannelMatcher(sourceCode, output); diff --git a/sonar-ws-client/src/main/java/org/sonar/wsclient/services/Measure.java b/sonar-ws-client/src/main/java/org/sonar/wsclient/services/Measure.java index 8327d9d8eef..d9986909f4d 100644 --- a/sonar-ws-client/src/main/java/org/sonar/wsclient/services/Measure.java +++ b/sonar-ws-client/src/main/java/org/sonar/wsclient/services/Measure.java @@ -42,6 +42,7 @@ public class Measure extends Model { /** * @deprecated since 2.5 See http://jira.codehaus.org/browse/SONAR-2007 */ + @Deprecated private String ruleCategory; private Double variation1, variation2, variation3, variation4, variation5; -- 2.39.5