Class ApiAnnotationAssert

  • All Implemented Interfaces:
    org.assertj.core.api.Assert<ApiAnnotationAssert,​Class>, org.assertj.core.api.Descriptable<ApiAnnotationAssert>, org.assertj.core.api.ExtensionPoints<ApiAnnotationAssert,​Class>

    public final class ApiAnnotationAssert
    extends org.assertj.core.api.AbstractAssert<ApiAnnotationAssert,​Class>
    This is the entry test class for API annotated classes. It will assert that a class was correctly annotated and that it conforms to the OpenAM conventions. The convenience method hasValidAnnotations() will do all assertions necessary to validate an annotated class.
    Since:
    14.0.0
    • Field Summary

      • Fields inherited from class org.assertj.core.api.AbstractAssert

        actual, info, myself, objects, throwUnsupportedExceptionOnEquals
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static ApiAnnotationAssert assertThat​(Class value)
      Get an instance of the assertion class for the given API annotated class.
      ApiProviderAssert classAnnotation()
      Get the test representative of SingletonProviders, CollectionProviders and RequestHandlers in the annotated class.
      void hasValidAnnotations()
      This convenience method will do all assertions necessary to validate that an annotated class was correctly annotated and that it conforms to the OpenAM conventions.
      ApiActionAssert methodAnnotations()
      Get the test representative of Create, Update, Delete, Patch, Action, Query) as a generic Annotation in the annotated class.
      • Methods inherited from class org.assertj.core.api.AbstractAssert

        actual, areEqual, asInstanceOf, asList, assertionError, asString, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, doesNotHaveSameHashCodeAs, doesNotHaveToString, doesNotHaveToString, doesNotMatch, doesNotMatch, equals, extracting, extracting, failure, failureWithActualExpected, failWithActualExpectedAndMessage, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, hasSameHashCodeAs, hasToString, hasToString, inBinary, inHexadecimal, is, isElementOfCustomAssert, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isInstanceOfSatisfying, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, matches, matches, newListAssertInstance, overridingErrorMessage, overridingErrorMessage, satisfies, satisfies, satisfies, satisfiesAnyOf, satisfiesAnyOf, satisfiesAnyOfForProxy, satisfiesForProxy, setCustomRepresentation, setDescriptionConsumer, setPrintAssertionsDescription, throwAssertionError, usingComparator, usingComparator, usingDefaultComparator, usingEquals, usingEquals, usingRecursiveAssertion, usingRecursiveAssertion, usingRecursiveComparison, usingRecursiveComparison, withFailMessage, withFailMessage, withRepresentation, withThreadDumpOnError
      • Methods inherited from interface org.assertj.core.api.Descriptable

        as, as, as, describedAs, describedAs
    • Method Detail

      • assertThat

        public static ApiAnnotationAssert assertThat​(Class value)
        Get an instance of the assertion class for the given API annotated class.
        Parameters:
        value - The API annotated class.
        Returns:
        The assertion instance.
      • classAnnotation

        public ApiProviderAssert classAnnotation()
        Get the test representative of SingletonProviders, CollectionProviders and RequestHandlers in the annotated class.
        Returns:
        The ApiProviderAssert containing the provider annotation.
      • methodAnnotations

        public ApiActionAssert methodAnnotations()
        Get the test representative of Create, Update, Delete, Patch, Action, Query) as a generic Annotation in the annotated class.
        Returns:
        The ApiActionAssert containing the method annotations.
      • hasValidAnnotations

        public void hasValidAnnotations()
        This convenience method will do all assertions necessary to validate that an annotated class was correctly annotated and that it conforms to the OpenAM conventions.