Package org.springdoc.core

Class SpringDocConfigProperties.GroupConfig

java.lang.Object
org.springdoc.core.SpringDocConfigProperties.GroupConfig
Enclosing class:
SpringDocConfigProperties
public static class SpringDocConfigProperties.GroupConfig extends Object
The type Group config.
Author:
bnasslahsen

  • Constructor Details

    • GroupConfig

      public GroupConfig()
      Instantiates a new Group config.

    • GroupConfig

      public GroupConfig(String group, List<String> pathsToMatch, List<String> packagesToScan, List<String> packagesToExclude, List<String> pathsToExclude, List<String> producesToMatch, List<String> consumesToMatch, List<String> headersToMatch, String displayName)
      Instantiates a new Group config.
      Parameters:
      group - the group
      pathsToMatch - the paths to match
      packagesToScan - the packages to scan
      packagesToExclude - the packages to exclude
      pathsToExclude - the paths to exclude
      producesToMatch - the produces to match
      consumesToMatch - the consumes to match
      headersToMatch - the headers to match
      displayName - the display name

  • Method Details

    • getHeadersToMatch

      public List<String> getHeadersToMatch()
      Gets headers to match.
      Returns:
      the headers to match

    • setHeadersToMatch

      public void setHeadersToMatch(List<String> headersToMatch)
      Sets headers to match.
      Parameters:
      headersToMatch - the headers to match

    • getConsumesToMatch

      public List<String> getConsumesToMatch()
      Gets consumes to match.
      Returns:
      the consumes to match

    • setConsumesToMatch

      public void setConsumesToMatch(List<String> consumesToMatch)
      Sets consumes to match.
      Parameters:
      consumesToMatch - the consumes to match

    • getPathsToMatch

      public List<String> getPathsToMatch()
      Gets paths to match.
      Returns:
      the paths to match

    • setPathsToMatch

      public void setPathsToMatch(List<String> pathsToMatch)
      Sets paths to match.
      Parameters:
      pathsToMatch - the paths to match

    • getPackagesToScan

      public List<String> getPackagesToScan()
      Gets packages to scan.
      Returns:
      the packages to scan

    • setPackagesToScan

      public void setPackagesToScan(List<String> packagesToScan)
      Sets packages to scan.
      Parameters:
      packagesToScan - the packages to scan

    • getGroup

      public String getGroup()
      Gets group.
      Returns:
      the group

    • setGroup

      public void setGroup(String group)
      Sets group.
      Parameters:
      group - the group

    • getPackagesToExclude

      public List<String> getPackagesToExclude()
      Gets packages to exclude.
      Returns:
      the packages to exclude

    • setPackagesToExclude

      public void setPackagesToExclude(List<String> packagesToExclude)
      Sets packages to exclude.
      Parameters:
      packagesToExclude - the packages to exclude

    • getPathsToExclude

      public List<String> getPathsToExclude()
      Gets paths to exclude.
      Returns:
      the paths to exclude

    • setPathsToExclude

      public void setPathsToExclude(List<String> pathsToExclude)
      Sets paths to exclude.
      Parameters:
      pathsToExclude - the paths to exclude

    • getProducesToMatch

      public List<String> getProducesToMatch()
      Gets produces to match.
      Returns:
      the produces to match

    • setProducesToMatch

      public void setProducesToMatch(List<String> producesToMatch)
      Sets produces to match.
      Parameters:
      producesToMatch - the produces to match

    • getDisplayName

      public String getDisplayName()
      Gets display name.
      Returns:
      the display name

    • setDisplayName

      public void setDisplayName(String displayName)
      Sets display name.
      Parameters:
      displayName - the display name