Package com.tngtech.archunit

Class ArchConfiguration

java.lang.Object
com.tngtech.archunit.ArchConfiguration
public final class ArchConfiguration
extends java.lang.Object
Allows access to configured properties in "archunit.properties".

  • Field Details

    • ARCHUNIT_PROPERTIES_RESOURCE_NAME

      @Internal public static final java.lang.String ARCHUNIT_PROPERTIES_RESOURCE_NAME
      See Also:
      Constant Field Values

    • RESOLVE_MISSING_DEPENDENCIES_FROM_CLASS_PATH

      @Internal public static final java.lang.String RESOLVE_MISSING_DEPENDENCIES_FROM_CLASS_PATH
      See Also:
      Constant Field Values

    • ENABLE_MD5_IN_CLASS_SOURCES

      @Internal public static final java.lang.String ENABLE_MD5_IN_CLASS_SOURCES
      See Also:
      Constant Field Values

  • Method Details

    • get

      @PublicAPI(usage=ACCESS) public static ArchConfiguration get()

    • reset

      @PublicAPI(usage=ACCESS) public void reset()

    • resolveMissingDependenciesFromClassPath

      @PublicAPI(usage=ACCESS) public boolean resolveMissingDependenciesFromClassPath()

    • setResolveMissingDependenciesFromClassPath

      @PublicAPI(usage=ACCESS) public void setResolveMissingDependenciesFromClassPath​(boolean newValue)

    • md5InClassSourcesEnabled

      @PublicAPI(usage=ACCESS) public boolean md5InClassSourcesEnabled()

    • setMd5InClassSourcesEnabled

      @PublicAPI(usage=ACCESS) public void setMd5InClassSourcesEnabled​(boolean enabled)

    • getClassResolver

      @PublicAPI(usage=ACCESS) public Optional<java.lang.String> getClassResolver()

    • setClassResolver

      @PublicAPI(usage=ACCESS) public void setClassResolver​(java.lang.Class<? extends ClassResolver> classResolver)

    • unsetClassResolver

      @PublicAPI(usage=ACCESS) public void unsetClassResolver()

    • getClassResolverArguments

      @PublicAPI(usage=ACCESS) public java.util.List<java.lang.String> getClassResolverArguments()

    • setClassResolverArguments

      @PublicAPI(usage=ACCESS) public void setClassResolverArguments​(java.lang.String... args)

    • setExtensionProperties

      @PublicAPI(usage=ACCESS) public void setExtensionProperties​(java.lang.String extensionIdentifier, java.util.Properties properties)

    • getExtensionProperties

      @PublicAPI(usage=ACCESS) public java.util.Properties getExtensionProperties​(java.lang.String extensionIdentifier)

    • configureExtension

      @PublicAPI(usage=ACCESS) public ArchConfiguration.ExtensionProperties configureExtension​(java.lang.String extensionIdentifier)

    • getSubProperties

      @PublicAPI(usage=ACCESS) public java.util.Properties getSubProperties​(java.lang.String propertyPrefix)
      Returns a set of properties where all keys share a common prefix. The prefix is removed from those property names. Example: 
      
 some.custom.prop1=value1
 some.custom.prop2=value2
 unrelated=irrelevant
      Then getSubProperties("some.custom") would return the properties 
      
 prop1=value1
 prop2=value2
      Parameters:
      propertyPrefix - A prefix for a set of properties
      Returns:
      All properties with this prefix, where the prefix is removed from the keys.

    • containsProperty

      @PublicAPI(usage=ACCESS) public boolean containsProperty​(java.lang.String propertyName)
      Parameters:
      propertyName - Full name of a property
      Returns:
      true, if and only if the property is configured within the global ArchUnit configuration.
      See Also:
      getProperty(String), setProperty(String, String)

    • getProperty

      @PublicAPI(usage=ACCESS) public java.lang.String getProperty​(java.lang.String propertyName)
      Parameters:
      propertyName - Full name of a property
      Returns:
      A property of the global ArchUnit configuration. This method will throw an exception if the property is not set within the configuration.
      See Also:
      containsProperty(String), setProperty(String, String)

    • setProperty

      @PublicAPI(usage=ACCESS) public void setProperty​(java.lang.String propertyName, java.lang.String value)
      Overwrites a property of the global ArchUnit configuration. Note that this change will persist for the whole life time of this JVM unless overwritten another time.
      Parameters:
      propertyName - Full name of a property
      value - The new value to set. Overwrites any existing property with the same name.
      See Also:
      containsProperty(String), getProperty(String)

    • getPropertyOrDefault

      @PublicAPI(usage=ACCESS) public java.lang.String getPropertyOrDefault​(java.lang.String propertyName, java.lang.String defaultValue)
      Parameters:
      propertyName - Full name of a property
      defaultValue - A value to return if property is not configured
      Returns:
      The property of the global ArchUnit configuration with the supplied name or defaultValue if this property is not configured.