Package org.pgcodekeeper.core.ignorelist

Interface IIgnoreList

All Known Implementing Classes:
IgnoreList, IgnoreSchemaList
public interface IIgnoreList
Interface for managing ignore lists used in database schema comparison. Provides basic operations for adding ignore rules and controlling visibility behavior.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(IgnoredObject rule)
    Adds an ignore rule to the list.
    List<IgnoredObject>
    getList()
    Gets the list of ignore rules.
    boolean
    isShow()
    Gets the default show behavior.
    static <T extends IIgnoreList>
    T
    parseIgnoreList(Path path, T ignoreList)
    Parses ignore list configuration from the specified file path and populates the provided ignore list instance with the parsed rules.
    void
    setShow(boolean isShow)
    Sets the default show behavior for this ignore list.

  • Method Details

    • getList

      List<IgnoredObject> getList()
      Gets the list of ignore rules.
      Returns:
      list of ignored objects

    • add

      void add(IgnoredObject rule)
      Adds an ignore rule to the list.
      Parameters:
      rule - the ignore rule to add

    • setShow

      void setShow(boolean isShow)
      Sets the default show behavior for this ignore list.
      Parameters:
      isShow - true for show-all (blacklist), false for hide-all (whitelist)

    • isShow

      boolean isShow()
      Gets the default show behavior.
      Returns:
      true if default is to show objects, false if default is to hide

    • parseIgnoreList

      static <T extends IIgnoreList> T parseIgnoreList(Path path, T ignoreList) throws IOException
      Parses ignore list configuration from the specified file path and populates the provided ignore list instance with the parsed rules. If the path is null, returns the ignore list without parsing.
      Type Parameters:
      T - the type of ignore list that extends IIgnoreList
      Parameters:
      path - the file path to parse ignore rules from, can be null
      ignoreList - the ignore list instance to populate with parsed rules
      Returns:
      the populated ignore list instance, or the original instance if path is null
      Throws:
      IOException - if an I/O error occurs while reading the file