• Overview
• Package
• Class
• Use
• Tree
• Deprecated
• Index
• Help

• Prev Class
• Next Class

• Frames
• No Frames

• All Classes

Class RuleSetReferenceId

• java.lang.Object
• • net.sourceforge.pmd.RuleSetReferenceId

• • Constructor Summary

    Constructors

    Constructor and Description
    RuleSetReferenceId (String id) Construct a RuleSetReferenceId for the given single ID string.
    RuleSetReferenceId (String id, RuleSetReferenceId externalRuleSetReferenceId) Construct a RuleSetReferenceId for the given single ID string.

  • Method Summary

    Methods

    Modifier and Type	Method and Description
    InputStream	getInputStream (ClassLoader classLoader) Try to load the RuleSet resource with the specified ClassLoader.
    String	getRuleName () Get the Rule name.
    String	getRuleSetFileName () Get the RuleSet file name.
    boolean	isAllRules () Is this a reference to all Rules in a RuleSet, or a single Rule?
    boolean	isExternal () Is this an external RuleSet reference?
    static List<RuleSetReferenceId>	parse (String referenceString) Parse a String comma separated list of RuleSet reference IDs into a List of RuleReferenceId instances.
    String	toString () Return the String form of this Rule reference.

    • Methods inherited from class java.lang.Object

      clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

• • Constructor Detail

    • RuleSetReferenceId

      public RuleSetReferenceId(String id)

      Construct a RuleSetReferenceId for the given single ID string.

      Parameters:

      id - The id string.

      Throws:

      IllegalArgumentException - If the ID contains a comma character.

    • RuleSetReferenceId

      public RuleSetReferenceId(String id,
       RuleSetReferenceId externalRuleSetReferenceId)

      Construct a RuleSetReferenceId for the given single ID string. If an external RuleSetReferenceId is given, the ID must refer to a non-external Rule. The external RuleSetReferenceId will be responsible for producing the InputStream containing the Rule.

      Parameters:

      id - The id string.

      externalRuleSetReferenceId - A RuleSetReferenceId to associate with this new instance.

      Throws:

      IllegalArgumentException - If the ID contains a comma character.

      IllegalArgumentException - If external RuleSetReferenceId is not external.

      IllegalArgumentException - If the ID is not Rule reference when there is an external RuleSetReferenceId.

  • Method Detail

    • parse

      public static List<RuleSetReferenceId> parse(String referenceString)

      Parse a String comma separated list of RuleSet reference IDs into a List of RuleReferenceId instances.

      Parameters:

      referenceString - A comma separated list of RuleSet reference IDs.

      Returns:

      The corresponding List of RuleSetReferenceId instances.

    • isExternal

      public boolean isExternal()

      Is this an external RuleSet reference?

      Returns:

      true if this is an external reference, false otherwise.

    • isAllRules

      public boolean isAllRules()

      Is this a reference to all Rules in a RuleSet, or a single Rule?

      Returns:

      true if this is a reference to all Rules, false otherwise.

    • getRuleSetFileName

      public String getRuleSetFileName()

      Get the RuleSet file name.

      Returns:

      The RuleSet file name if this is an external reference, null otherwise.

    • getRuleName

      public String getRuleName()

      Get the Rule name.

      Returns:

      The Rule name. The Rule name.

    • getInputStream

      public InputStream getInputStream(ClassLoader classLoader)
       throws RuleSetNotFoundException 

      Try to load the RuleSet resource with the specified ClassLoader. Multiple attempts to get independent InputStream instances may be made, so subclasses must ensure they support this behavior. Delegates to an external RuleSetReferenceId if there is one associated with this instance.

      Parameters:

      classLoader - The ClassLoader to use.

      Returns:

      An InputStream to that resource.

      Throws:

      RuleSetNotFoundException - if unable to find a resource.

    • toString

      public String toString()

      Return the String form of this Rule reference.

      Overrides:

      toString in class Object

      Returns:

      Return the String form of this Rule reference, which is ruleSetFileName for all Rule external references, ruleSetFileName/ruleName, for a single Rule external references, or ruleName otherwise.