Class RuleSetFactoryCompatibility


  • public class RuleSetFactoryCompatibility
    extends java.lang.Object
    Provides a simple filter mechanism to avoid failing to parse an old ruleset, which references rules, that have either been removed from PMD already or renamed or moved to another ruleset.
    See Also:
    issue 1360
    • Constructor Summary

      Constructors 
      Constructor Description
      RuleSetFactoryCompatibility()
      Creates a new instance of the compatibility filter with the built-in filters for the modified PMD rules.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.io.Reader filterRuleSetFile​(java.io.InputStream stream)
      Applies all configured filters against the given input stream.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • RuleSetFactoryCompatibility

        public RuleSetFactoryCompatibility()
        Creates a new instance of the compatibility filter with the built-in filters for the modified PMD rules.
    • Method Detail

      • filterRuleSetFile

        public java.io.Reader filterRuleSetFile​(java.io.InputStream stream)
                                         throws java.io.IOException
        Applies all configured filters against the given input stream. The resulting reader will contain the original ruleset modified by the filters.
        Parameters:
        stream - the original ruleset file input stream
        Returns:
        a reader, from which the filtered ruleset can be read
        Throws:
        java.io.IOException - if the stream couldn't be read