接口 AotTestAttributes

所有已知实现类:
DefaultAotTestAttributes

public interface AotTestAttributes
Holder for metadata specific to ahead-of-time (AOT) support in the Infra TestContext Framework.

AOT test attributes are supported in two modes of operation: build-time and run-time. At build time, test components can contribute attributes during the AOT processing phase. At run time, test components can retrieve attributes that were contributed at build time. If AotDetector.useGeneratedArtifacts() returns true, run-time mode applies.

For example, if a test component computes something at build time that cannot be computed at run time, the result of the build-time computation can be stored as an AOT attribute and retrieved at run time without repeating the computation.

An AotContextLoader would typically contribute an attribute in loadContextForAotProcessing(); whereas, an AotTestExecutionListener would typically contribute an attribute in processAheadOfTime(). Any other test component — such as a TestContextBootstrapper — can choose to contribute an attribute at any point in time. Note that contributing an attribute during standard JVM test execution will not have any adverse side effect since AOT attributes will be ignored in that scenario. In any case, you should use AotDetector.useGeneratedArtifacts() to determine if invocations of setAttribute(String, String) and removeAttribute(String) are permitted.

从以下版本开始:
4.0
作者:
Sam Brannen, Harry Yang
  • 方法概要

    修饰符和类型
    方法
    说明
    default boolean
    Retrieve the attribute value for the given name as a boolean.
    Get the current instance of AotTestAttributes to use.
    Retrieve the attribute value for the given name as a String.
    void
    Remove the attribute stored under the provided name.
    default void
    setAttribute(String name, boolean value)
    Set a boolean attribute for later retrieval during AOT run-time execution.
    void
    setAttribute(String name, String value)
    Set a String attribute for later retrieval during AOT run-time execution.
  • 方法详细资料

    • getInstance

      static AotTestAttributes getInstance()
      Get the current instance of AotTestAttributes to use.

      See the class-level Javadoc for details on the two supported modes.

    • setAttribute

      void setAttribute(String name, String value)
      Set a String attribute for later retrieval during AOT run-time execution.

      In general, users should take care to prevent overlaps with other metadata attributes by using fully-qualified names, perhaps using a class or package name as a prefix.

      参数:
      name - the unique attribute name
      value - the associated attribute value
      抛出:
      UnsupportedOperationException - if invoked during AOT run-time execution
      IllegalArgumentException - if the provided value is null or if an attempt is made to override an existing attribute
      另请参阅:
    • setAttribute

      default void setAttribute(String name, boolean value)
      Set a boolean attribute for later retrieval during AOT run-time execution.

      In general, users should take care to prevent overlaps with other metadata attributes by using fully-qualified names, perhaps using a class or package name as a prefix.

      参数:
      name - the unique attribute name
      value - the associated attribute value
      抛出:
      UnsupportedOperationException - if invoked during AOT run-time execution
      IllegalArgumentException - if an attempt is made to override an existing attribute
      另请参阅:
    • removeAttribute

      void removeAttribute(String name)
      Remove the attribute stored under the provided name.
      参数:
      name - the unique attribute name
      抛出:
      UnsupportedOperationException - if invoked during AOT run-time execution
      另请参阅:
    • getString

      @Nullable String getString(String name)
      Retrieve the attribute value for the given name as a String.
      参数:
      name - the unique attribute name
      返回:
      the associated attribute value, or null if not found
      另请参阅:
    • getBoolean

      default boolean getBoolean(String name)
      Retrieve the attribute value for the given name as a boolean.
      参数:
      name - the unique attribute name
      返回:
      true if the attribute is set to "true" (ignoring case), false otherwise
      另请参阅: