Class IgnorableDescriptor<T extends IgnorableDescriptor<T>>

java.lang.Object
org.springframework.restdocs.snippet.AbstractDescriptor<T>
org.springframework.restdocs.snippet.IgnorableDescriptor<T>
Type Parameters:
T - the type of the descriptor
Direct Known Subclasses:
CookieDescriptor, FieldDescriptor, LinkDescriptor, ParameterDescriptor, RequestPartDescriptor

public abstract class IgnorableDescriptor<T extends IgnorableDescriptor<T>> extends AbstractDescriptor<T>
Base class for descriptors for items that can be ignored.
Author:
Andy Wilkinson
  • Constructor Details

    • IgnorableDescriptor

      public IgnorableDescriptor()
  • Method Details

    • ignored

      public final T ignored()
      Marks the described item as being ignored. Ignored items are not included in the generated documentation.
      Returns:
      the descriptor
    • isIgnored

      public final boolean isIgnored()
      Returns whether or not the item being described should be ignored and, therefore, should not be included in the documentation.
      Returns:
      true if the item should be ignored, otherwise false.