diff --git a/config/checkstyle_checks.xml b/config/checkstyle_checks.xml index 1a504b4ee..af53f21e0 100644 --- a/config/checkstyle_checks.xml +++ b/config/checkstyle_checks.xml @@ -66,6 +66,7 @@ + diff --git a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/builder/CheckstyleMarker.java b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/builder/CheckstyleMarker.java index 0a5b1fcf6..89fe926b2 100644 --- a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/builder/CheckstyleMarker.java +++ b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/builder/CheckstyleMarker.java @@ -47,4 +47,4 @@ public final class CheckstyleMarker { private CheckstyleMarker() { // NOOP } -} \ No newline at end of file +} diff --git a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/ICheckConfiguration.java b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/ICheckConfiguration.java index 85afea88b..620fc644a 100644 --- a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/ICheckConfiguration.java +++ b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/ICheckConfiguration.java @@ -29,56 +29,56 @@ /** * Interface for a check configuration object. - * + * * @author Lars Ködderitzsch */ public interface ICheckConfiguration { /** * Returns the displayable name of the configuration. - * + * * @return the displayable name of the configuration */ String getName(); /** * Return a description of the check configuration. - * + * * @return a description. */ String getDescription(); /** * Returns the location of the checkstyle configuration file. - * + * * @return the location of the configuration file */ String getLocation(); /** * Return the type of the configuration. - * + * * @return the configuration type */ IConfigurationType getType(); /** * Gets additional data for this configuration. - * + * * @return the additional data in form of a Map */ Map getAdditionalData(); /** * Returns the list of properties added to the configuration. - * + * * @return the list of configured properties */ List getResolvableProperties(); /** * Determines if the configuration properties are editable by the user. - * + * * @return true, if the configuration is editable */ boolean isEditable(); @@ -86,7 +86,7 @@ public interface ICheckConfiguration { /** * Determines if the checkstyle configuration associates with this check configuration can be * configured. - * + * * @return true if the checkstyle configuration can be configured. */ boolean isConfigurable(); @@ -94,7 +94,7 @@ public interface ICheckConfiguration { /** * Returns if the check configuration is a global configuration, configured for the workspace, or * a local configuration for a single project. - * + * * @return true if the check configuration is configured globally */ boolean isGlobal(); @@ -103,7 +103,7 @@ public interface ICheckConfiguration { * Returns the resolved location URL of the Checkstyle configuration file configured for this * check configuration. Clients should not try to open an actual stream to the configuration file, * since this is not guaranteed to work. - * + * * @return the Checkstyle configuration file location as URL * @throws CheckstylePluginException * exception while resolving the URL @@ -113,10 +113,10 @@ public interface ICheckConfiguration { /** * Get all data of the Checkstyle configuration (file data, additional properties...) in one go. * This is done to optimize the number of accesses that must be done on the configuration files. - * + * * @return all Checkstyle configuration file data necessary to create a checker * @throws CheckstylePluginException * exception while getting the Checkstyle configuration file data */ CheckstyleConfigurationFile getCheckstyleConfiguration() throws CheckstylePluginException; -} \ No newline at end of file +} diff --git a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/ICheckConfigurationWorkingSet.java b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/ICheckConfigurationWorkingSet.java index 93ec28413..5fd2ad16a 100644 --- a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/ICheckConfigurationWorkingSet.java +++ b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/ICheckConfigurationWorkingSet.java @@ -29,7 +29,7 @@ /** * Interface for implementations that provide editing services for a group of check configuration. - * + * * @author Lars Ködderitzsch */ public interface ICheckConfigurationWorkingSet { @@ -38,7 +38,7 @@ public interface ICheckConfigurationWorkingSet { * Creates a new working copy for an existing check configuration. The working copy is associated * with this working set albeit the new working copy is not added to the working sets list of * workin copies. - * + * * @param checkConfig * the check configuration to create the working copy for * @return the working copy @@ -49,7 +49,7 @@ public interface ICheckConfigurationWorkingSet { * Creates a new working copy with a given configuration type. The working copy is associated with * this working set albeit the new working copy is not added to the working sets list of workin * copies. - * + * * @param configType * the desired configuration type of the new working copy * @return the working copy @@ -58,7 +58,7 @@ public interface ICheckConfigurationWorkingSet { /** * Returns the working copies that belong to this working set. - * + * * @return the working copies */ CheckConfigurationWorkingCopy[] getWorkingCopies(); @@ -66,7 +66,7 @@ public interface ICheckConfigurationWorkingSet { /** * Checks if the name of a check configuration (in form of a working copy) clashes with an * existing configuration. Names of check configurations must be unique within the working copy. - * + * * @param configuration * the working copy to check * @return true if there is a collision, false otherwise @@ -75,7 +75,7 @@ public interface ICheckConfigurationWorkingSet { /** * Adds a working copy to the working set. - * + * * @param checkConfig * the working copy to add */ @@ -84,7 +84,7 @@ public interface ICheckConfigurationWorkingSet { /** * Removes a working copy from the working set. Returns true if the configuration * could be removed, false if it could not be removed because it is being used. - * + * * @param checkConfig * the working copy to remove * @return true if the configuration was removed, false if it is being @@ -94,7 +94,7 @@ public interface ICheckConfigurationWorkingSet { /** * Stores the working set (it configurations) to persistence. - * + * * @throws CheckstylePluginException * when storing of the configurations failed */ @@ -102,17 +102,17 @@ public interface ICheckConfigurationWorkingSet { /** * Determines if the working set changed. - * + * * @return true if the working set changed, false otherwise */ boolean isDirty(); /** * Returns a collection of projects affected by the changes of the working set. - * + * * @return the collection of affected projects * @throws CheckstylePluginException * unexprected error */ Collection getAffectedProjects() throws CheckstylePluginException; -} \ No newline at end of file +} diff --git a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/Module.java b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/Module.java index ea37c5ce3..07aecbe4a 100644 --- a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/Module.java +++ b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/Module.java @@ -312,4 +312,4 @@ public Module clone() { throw new InternalError(ex); } } -} \ No newline at end of file +} diff --git a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/meta/AllTokensProvider.java b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/meta/AllTokensProvider.java index 7014eda4d..62ca0f0d0 100644 --- a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/meta/AllTokensProvider.java +++ b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/meta/AllTokensProvider.java @@ -29,7 +29,7 @@ /** * Class that provides all known tokens from the checkstyle java grammar. This is used for modules * that allow all tokens as options - which is very tedious to maintain in the metadata. - * + * * @author Lars Ködderitzsch */ public class AllTokensProvider implements IOptionProvider { @@ -54,11 +54,11 @@ public class AllTokensProvider implements IOptionProvider { /** * Returns all options. - * + * * @return the options */ @Override public List getOptions() { return sAllOptions; } -} \ No newline at end of file +} diff --git a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/meta/ConfigPropertyMetadata.java b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/meta/ConfigPropertyMetadata.java index 8cedd6fd4..0fb19b499 100644 --- a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/meta/ConfigPropertyMetadata.java +++ b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/meta/ConfigPropertyMetadata.java @@ -50,7 +50,7 @@ public class ConfigPropertyMetadata { /** * Creates the property metadata. - * + * * @param type * the property type * @param name @@ -71,7 +71,7 @@ public ConfigPropertyMetadata(ConfigPropertyType type, String name, String defau /** * Get the property's datatype. - * + * * @return The datatype */ public ConfigPropertyType getDatatype() { @@ -80,7 +80,7 @@ public ConfigPropertyType getDatatype() { /** * Get the property's name. - * + * * @return The name */ public String getName() { @@ -89,7 +89,7 @@ public String getName() { /** * Get the property's description. - * + * * @return The description */ public String getDescription() { @@ -98,7 +98,7 @@ public String getDescription() { /** * Sets the description of this property. - * + * * @param description * the description */ @@ -108,7 +108,7 @@ public void setDescription(String description) { /** * Get the default value. - * + * * @return The default value */ public String getDefaultValue() { @@ -117,7 +117,7 @@ public String getDefaultValue() { /** * Returns a default value differing from the Checkstye default for this property. - * + * * @return The differing checkstyle default value. */ public String getOverrideDefault() { @@ -126,7 +126,7 @@ public String getOverrideDefault() { /** * Get the enumeration of allowable values. - * + * * @return Enumeration of values */ public List getPropertyEnumeration() { @@ -135,11 +135,11 @@ public List getPropertyEnumeration() { /** * Returns the hidden. - * + * * @return boolean */ public boolean isHidden() { return ConfigPropertyType.Hidden.equals(mDatatype); } -} \ No newline at end of file +} diff --git a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/meta/ConfigPropertyType.java b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/meta/ConfigPropertyType.java index 72f173e1c..c4769bb21 100644 --- a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/meta/ConfigPropertyType.java +++ b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/meta/ConfigPropertyType.java @@ -51,4 +51,4 @@ public enum ConfigPropertyType { /** A value that contains a regular expression. */ Regex -} \ No newline at end of file +} diff --git a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/meta/IOptionProvider.java b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/meta/IOptionProvider.java index 51ebbfef8..b3bdc1d76 100644 --- a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/meta/IOptionProvider.java +++ b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/meta/IOptionProvider.java @@ -26,15 +26,15 @@ * Interface for an option provider. This is used to provide dynamic or massive amount of options * which would be too difficult to handle in metadata. For instance this is true for module metadata * that need all token types as options. - * + * * @author Lars Ködderitzsch */ public interface IOptionProvider { /** * Returns a list of options. - * + * * @return the options */ List getOptions(); -} \ No newline at end of file +} diff --git a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/meta/RuleMetadata.java b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/meta/RuleMetadata.java index 65afb9806..c12431cc4 100644 --- a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/meta/RuleMetadata.java +++ b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/meta/RuleMetadata.java @@ -75,7 +75,7 @@ public class RuleMetadata { /** * Creates a rule metadata. - * + * * @param ruleName * the name of the rule * @param internalName @@ -114,7 +114,7 @@ public RuleMetadata(String ruleName, String internalName, String parent, Severit /** * Adds an alternative name for this rule. - * + * * @param alternativeName * an alternative name for this rule */ @@ -124,7 +124,7 @@ public void addAlternativeName(String alternativeName) { /** * Returns the list of alternative names. - * + * * @return a collection of String */ public Collection getAlternativeNames() { @@ -133,7 +133,7 @@ public Collection getAlternativeNames() { /** * Adds a quickfixfor this rule. - * + * * @param quickfixClassName * the fully qualified classname of the quickfix */ @@ -143,7 +143,7 @@ public void addQuickfix(String quickfixClassName) { /** * Returns the list quickfixes for this module. - * + * * @return a collection of quickfix class names */ public Collection getQuickfixClassNames() { @@ -152,7 +152,7 @@ public Collection getQuickfixClassNames() { /** * Adds a message key to this module metadata. - * + * * @param messageKey * the message key to add */ @@ -162,7 +162,7 @@ public void addMessageKey(String messageKey) { /** * Returns the collection of message keys used by this module. - * + * * @return the list of message keys */ public Collection getMessageKeys() { @@ -171,7 +171,7 @@ public Collection getMessageKeys() { /** * Returns the default severity level. - * + * * @return The severity level. */ public Severity getDefaultSeverityLevel() { @@ -180,7 +180,7 @@ public Severity getDefaultSeverityLevel() { /** * Returns the rule's description. - * + * * @return Rule description */ public String getDescription() { @@ -189,7 +189,7 @@ public String getDescription() { /** * Set the description for the rule. - * + * * @param description * the description */ @@ -199,7 +199,7 @@ public void setDescription(String description) { /** * Returns the rule's name. - * + * * @return String */ public String getRuleName() { @@ -209,7 +209,7 @@ public String getRuleName() { /** * Returns the internal name of the module. The internal name is the name of the module inside the * checkstyle configuration file. - * + * * @return the internal module name */ public String getInternalName() { @@ -218,7 +218,7 @@ public String getInternalName() { /** * Determine if the module is to be hidden from the users sight. - * + * * @return true if the module is hidden */ public boolean isHidden() { @@ -227,7 +227,7 @@ public boolean isHidden() { /** * Determine if the module has a severity to configure. - * + * * @return true if the module has a severity */ public boolean hasSeverity() { @@ -236,7 +236,7 @@ public boolean hasSeverity() { /** * Determine if the module can be removed from the configuration. - * + * * @return true if the module can be removed */ public boolean isDeletable() { @@ -245,7 +245,7 @@ public boolean isDeletable() { /** * Determine if the module is a singleton inside a checkstyle configuration. - * + * * @return true if the module is a singleton */ public boolean isSingleton() { @@ -254,7 +254,7 @@ public boolean isSingleton() { /** * Gets the name of the parent module. - * + * * @return the parent module */ public String getParentModule() { @@ -263,7 +263,7 @@ public String getParentModule() { /** * Returns the configuration property metadata. - * + * * @return A list of ConfigPropertyMetadata objects. */ public List getPropertyMetadata() { @@ -272,7 +272,7 @@ public List getPropertyMetadata() { /** * Returns the property meta data for a given property name. - * + * * @param property * the property name * @return the coresponding property meta data or null @@ -296,10 +296,10 @@ public ConfigPropertyMetadata getPropertyMetadata(String property) { /** * Returns the group this rule belongs to. - * + * * @return the group */ public RuleGroupMetadata getGroup() { return mGroup; } -} \ No newline at end of file +} diff --git a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/savefilter/CheckerModuleSaveFilter.java b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/savefilter/CheckerModuleSaveFilter.java index 2f1565271..170528e3e 100644 --- a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/savefilter/CheckerModuleSaveFilter.java +++ b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/config/savefilter/CheckerModuleSaveFilter.java @@ -28,7 +28,7 @@ /** * Special module logic for the Checker module. - * + * * @author Lars Ködderitzsch */ public class CheckerModuleSaveFilter implements ISaveFilter { @@ -55,4 +55,4 @@ public void postProcessConfiguredModules(List configuredModules) { configuredModules.add(0, checker); } } -} \ No newline at end of file +} diff --git a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/jobs/ConfigureDeconfigureNatureJob.java b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/jobs/ConfigureDeconfigureNatureJob.java index 1d1dac31b..5510136aa 100644 --- a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/jobs/ConfigureDeconfigureNatureJob.java +++ b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/jobs/ConfigureDeconfigureNatureJob.java @@ -38,7 +38,7 @@ * This operation configures or deconfigures a project with a given nature. If the project is * already configured with this nature, the nature will be deconfigured. Otherwise if the project is * not configured with this nature, the nature will be configured for this project - * + * * @author Lars Ködderitzsch */ public class ConfigureDeconfigureNatureJob extends WorkspaceJob { @@ -54,7 +54,7 @@ public class ConfigureDeconfigureNatureJob extends WorkspaceJob { /** * Construktor for this operation. - * + * * @param project * the project to be configured/deconfiured * @param natureId @@ -89,7 +89,7 @@ public IStatus runInWorkspace(IProgressMonitor monitor) throws CoreException { /** * Helper method to enable the given nature for the project. - * + * * @throws CoreException * an error while setting the nature occured */ @@ -112,7 +112,7 @@ private void enableNature() throws CoreException { /** * Helper method to disable the given nature for the project. - * + * * @throws CoreException * an error while removing the nature occured */ @@ -136,4 +136,4 @@ private void disableNature() throws CoreException { mProject.setDescription(desc, mMonitor); } -} \ No newline at end of file +} diff --git a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/projectconfig/XMLTags.java b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/projectconfig/XMLTags.java index d19270744..fde722d67 100644 --- a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/projectconfig/XMLTags.java +++ b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/projectconfig/XMLTags.java @@ -76,4 +76,4 @@ private XMLTags() { // NOOP } -} \ No newline at end of file +} diff --git a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/projectconfig/filters/IFilter.java b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/projectconfig/filters/IFilter.java index f23f655d5..4bb52ecdb 100644 --- a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/projectconfig/filters/IFilter.java +++ b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/projectconfig/filters/IFilter.java @@ -24,14 +24,14 @@ /** * Interface for a filter. - * + * * @author Lars Ködderitzsch */ public interface IFilter extends Cloneable { /** * Initializes this filter with common attributes. - * + * * @param name * the name of the filter * @param internalName @@ -45,42 +45,42 @@ public interface IFilter extends Cloneable { /** * Gets the displayable name of the filter. - * + * * @return the filter name */ String getName(); /** * Gets the internal name of the filter. - * + * * @return the internal name */ String getInternalName(); /** * Gets the description of the filter. - * + * * @return the description */ String getDescription(); /** * Returns if the filter is readonly. - * + * * @return true - if the filter is readonly */ boolean isReadonly(); /** * Returns if the filter is selected. - * + * * @return true - if the filter is selected */ boolean isEnabled(); /** * Sets the filter as selected. - * + * * @param selected * true - if the filter is selected */ @@ -88,14 +88,14 @@ public interface IFilter extends Cloneable { /** * Returns the data of this filter. - * + * * @return the filter data */ List getFilterData(); /** * Sets the filter data for this filter. - * + * * @param filterData * the filter data */ @@ -103,25 +103,25 @@ public interface IFilter extends Cloneable { /** * Returns a presentable form of the filter data of editable filters. - * + * * @return Presentable filter data */ String getPresentableFilterData(); /** * A clone of this filter. - * + * * @return the clone */ IFilter clone(); /** * Determines wheter an object passes this filter. - * + * * @param element * the element to check * @return true - the element passes the filter */ boolean accept(Object element); -} \ No newline at end of file +} diff --git a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/projectconfig/filters/NonSrcDirsFilter.java b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/projectconfig/filters/NonSrcDirsFilter.java index 06717f4c8..593813d98 100644 --- a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/projectconfig/filters/NonSrcDirsFilter.java +++ b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/projectconfig/filters/NonSrcDirsFilter.java @@ -97,4 +97,4 @@ private List getSourceDirPaths(IProject project) { return sourceDirs; } -} \ No newline at end of file +} diff --git a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/projectconfig/filters/UnOpenedFilesFilter.java b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/projectconfig/filters/UnOpenedFilesFilter.java index f926228ec..982c64983 100644 --- a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/projectconfig/filters/UnOpenedFilesFilter.java +++ b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/projectconfig/filters/UnOpenedFilesFilter.java @@ -27,7 +27,7 @@ /** * Filter that excludes all files that are not opened in an eclipse editor. - * + * * @author Lars Ködderitzsch */ public class UnOpenedFilesFilter extends AbstractFilter { @@ -36,7 +36,7 @@ public class UnOpenedFilesFilter extends AbstractFilter { /** * Registers a opened file. - * + * * @param file * the file */ @@ -46,7 +46,7 @@ public static void addOpenedFile(IFile file) { /** * Deregisters the opened file. - * + * * @param file * the file */ @@ -63,4 +63,4 @@ public boolean accept(Object element) { } return false; } -} \ No newline at end of file +} diff --git a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/util/CheckstyleLog.java b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/util/CheckstyleLog.java index 5e13c5b04..4c5645edf 100644 --- a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/util/CheckstyleLog.java +++ b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/util/CheckstyleLog.java @@ -44,7 +44,7 @@ private CheckstyleLog() { /** * Logs the exceptions. - * + * * @param error * the exception to log */ @@ -54,7 +54,7 @@ public static void log(Throwable error) { /** * Logs the exception, describing it with the given message. - * + * * @param throwable * the exception to log * @param message @@ -66,4 +66,4 @@ public static void log(Throwable throwable, String message) { log.log(status); } -} \ No newline at end of file +} diff --git a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/util/XMLUtil.java b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/util/XMLUtil.java index c6a30408c..566898ca2 100644 --- a/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/util/XMLUtil.java +++ b/net.sf.eclipsecs.core/src/net/sf/eclipsecs/core/util/XMLUtil.java @@ -100,4 +100,4 @@ public InputSource resolveEntity(String publicId, String systemId) throws SAXExc return null; } } -} \ No newline at end of file +}