Class ModuleDetails

java.lang.Object
com.puppycrawl.tools.checkstyle.meta.ModuleDetails

public final class ModuleDetails extends Object
Simple POJO class for module details.
  • Field Details

  • Constructor Details

  • Method Details

    • getName

      public String getName ()
      Get name of module.
      Returns:
      name of module
    • setName

      public void setName (String name)
      Set name of module.
      Parameters:
      name - module name
    • getFullQualifiedName

      Get fully qualified name of module.
      Returns:
      fully qualified name of module
    • setFullQualifiedName

      public void setFullQualifiedName (String fullQualifiedName)
      Set fully qualified name of module.
      Parameters:
      fullQualifiedName - fully qualified name of module
    • getParent

      public String getParent ()
      Get parent of module.
      Returns:
      parent of module
    • setParent

      public void setParent (String parent)
      Set parent of module.
      Parameters:
      parent - parent of module
    • getDescription

      Get description of module.
      Returns:
      description of module
    • setDescription

      public void setDescription (String description)
      Set description of module.
      Parameters:
      description - description of module
    • getProperties

      Get property list of module.
      Returns:
      property list of module
    • addToProperties

      public void addToProperties (ModulePropertyDetails property)
      Add a single module property to the module's property list and map both.
      Parameters:
      property - module property
    • addToProperties

      public void addToProperties (List<ModulePropertyDetails> modulePropertyDetailsList)
      Add a list of properties to the module's property list and map both.
      Parameters:
      modulePropertyDetailsList - list of module property
    • getViolationMessageKeys

      Get violation message keys of the module.
      Returns:
      violation message keys of module
    • addToViolationMessages

      public void addToViolationMessages (String msg)
      Add a key to the violation message key list of the module.
      Parameters:
      msg - violation message key
    • addToViolationMessages

      public void addToViolationMessages (List<String> msgList)
      Add a list of keys to the violation message key list of the module.
      Parameters:
      msgList - a list of violation message keys
    • getModuleType

      Get module type.
      Returns:
      module type
    • setModuleType

      public void setModuleType (ModuleType moduleType)
      Set type of module.
      Parameters:
      moduleType - type of module