Package org.ossreviewtoolkit.model.config

Enum PathExcludeReason

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BUILD_TOOL_OF

      The path only contains tools used for building source code which are not included in distributed build artifacts.
      DATA_FILE_OF

      The path only contains data files such as fonts or images which are not included in distributed build artifacts.
      DOCUMENTATION_OF

      The path only contains documentation which is not included in distributed build artifacts.
      EXAMPLE_OF

      The path only contains source code examples which are not included in distributed build artifacts.
      OPTIONAL_COMPONENT_OF

      The path only contains optional components for the code that is built which are not included in distributed build artifacts.
      OTHER

      Any other reason which cannot be represented by any other element of PathExcludeReason.
      PROVIDED_BY

      The path only contains packages or sources for packages that have to be provided by the user of distributed build artifacts.
      TEST_OF

      The path only contains files used for testing source code which are not included in distributed build artifacts.
      TEST_TOOL_OF

      The path only contains tools used for testing source code which are not included in distributed build artifacts.

    • Method Summary

      Modifier and Type Method Description
      final PathExcludeReason valueOf(String value) Returns the enum constant of this type with the specified name.
      final Array<PathExcludeReason> values() Returns an array containing the constants of this enum type, in the order they're declared.
      final EnumEntries<PathExcludeReason> getEntries() Possible reasons for excluding a path.

      • Methods inherited from class kotlin.Enum

        getName, getOrdinal

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • valueOf

         final PathExcludeReason valueOf(String value)

        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

      • values

         final Array<PathExcludeReason> values()

        Returns an array containing the constants of this enum type, in the order they're declared.

        This method may be used to iterate over the constants.