Class ObservableRuleBuilder

  • All Implemented Interfaces:
    SettingsOwner
    Direct Known Subclasses:
    ObservableXPathRuleBuilder

    public class ObservableRuleBuilder
    extends java.lang.Object
    implements SettingsOwner
    Holds info about a rule, and can build it to validate it.
    Since:
    6.0.0
    Author:
    Clément Fournier
    • Constructor Detail

      • ObservableRuleBuilder

        public ObservableRuleBuilder()
    • Method Detail

      • getLanguage

        public net.sourceforge.pmd.lang.Language getLanguage()
      • setLanguage

        public void setLanguage​(net.sourceforge.pmd.lang.Language language)
      • languageProperty

        public org.reactfx.value.Var<net.sourceforge.pmd.lang.Language> languageProperty()
      • getName

        public java.lang.String getName()
      • setName

        public void setName​(java.lang.String name)
      • nameProperty

        public org.reactfx.value.Var<java.lang.String> nameProperty()
      • getClazz

        public java.lang.Class<?> getClazz()
      • setClazz

        public void setClazz​(java.lang.Class<?> clazz)
      • clazzProperty

        public org.reactfx.value.Var<java.lang.Class<?>> clazzProperty()
      • setRuleProperties

        public void setRuleProperties​(javafx.collections.ObservableList<PropertyDescriptorSpec> ruleProperties)
      • rulePropertiesProperty

        public javafx.beans.property.ListProperty<PropertyDescriptorSpec> rulePropertiesProperty()
      • getMinimumVersion

        public net.sourceforge.pmd.lang.LanguageVersion getMinimumVersion()
      • setMinimumVersion

        public void setMinimumVersion​(net.sourceforge.pmd.lang.LanguageVersion minimumVersion)
      • minimumVersionProperty

        public org.reactfx.value.Var<net.sourceforge.pmd.lang.LanguageVersion> minimumVersionProperty()
      • getMaximumVersion

        public net.sourceforge.pmd.lang.LanguageVersion getMaximumVersion()
      • setMaximumVersion

        public void setMaximumVersion​(net.sourceforge.pmd.lang.LanguageVersion maximumVersion)
      • maximumVersionProperty

        public org.reactfx.value.Var<net.sourceforge.pmd.lang.LanguageVersion> maximumVersionProperty()
      • getSince

        public java.lang.String getSince()
      • setSince

        public void setSince​(java.lang.String since)
      • sinceProperty

        public org.reactfx.value.Var<java.lang.String> sinceProperty()
      • getMessage

        public java.lang.String getMessage()
      • setMessage

        public void setMessage​(java.lang.String message)
      • messageProperty

        public org.reactfx.value.Var<java.lang.String> messageProperty()
      • getExternalInfoUrl

        public java.lang.String getExternalInfoUrl()
      • setExternalInfoUrl

        public void setExternalInfoUrl​(java.lang.String externalInfoUrl)
      • externalInfoUrlProperty

        public org.reactfx.value.Var<java.lang.String> externalInfoUrlProperty()
      • getDescription

        public java.lang.String getDescription()
      • setDescription

        public void setDescription​(java.lang.String description)
      • descriptionProperty

        public org.reactfx.value.Var<java.lang.String> descriptionProperty()
      • getExamples

        public org.reactfx.value.Var<javafx.collections.ObservableList<java.lang.String>> getExamples()
      • setExamples

        public void setExamples​(javafx.collections.ObservableList<java.lang.String> examples)
      • getPriority

        public net.sourceforge.pmd.RulePriority getPriority()
      • setPriority

        public void setPriority​(net.sourceforge.pmd.RulePriority priority)
      • priorityProperty

        public org.reactfx.value.Var<net.sourceforge.pmd.RulePriority> priorityProperty()
      • isDeprecated

        public boolean isDeprecated()
      • setDeprecated

        public void setDeprecated​(boolean deprecated)
      • deprecatedProperty

        public org.reactfx.value.Var<java.lang.Boolean> deprecatedProperty()
      • isUsesDfa

        public boolean isUsesDfa()
      • setUsesDfa

        public void setUsesDfa​(boolean usesDfa)
      • usesDfaProperty

        public org.reactfx.value.Var<java.lang.Boolean> usesDfaProperty()
      • isUsesMultifile

        public boolean isUsesMultifile()
      • setUsesMultifile

        public void setUsesMultifile​(boolean usesMultifile)
      • usesMultifileProperty

        public org.reactfx.value.Var<java.lang.Boolean> usesMultifileProperty()
      • getUsesTypeResolution

        public boolean getUsesTypeResolution()
      • setUsesTypeResolution

        public void setUsesTypeResolution​(boolean usesTypeResolution)
      • usesTypeResolutionProperty

        public org.reactfx.value.Var<java.lang.Boolean> usesTypeResolutionProperty()
      • canBuild

        public boolean canBuild()
        Returns true if the parameters of the rule are consistent and the rule can be built.
        Returns:
        whether the rule can be built
      • build

        public java.util.Optional<net.sourceforge.pmd.Rule> build()
                                                           throws java.lang.IllegalArgumentException
        Builds the rule.
        Returns:
        the built rule.
        Throws:
        java.lang.IllegalArgumentException - if parameters are incorrect