クラス IgnorableDescriptor<T extends IgnorableDescriptor<T>>

java.lang.ObjectSE
org.springframework.restdocs.snippet.AbstractDescriptor<T>
org.springframework.restdocs.snippet.IgnorableDescriptor<T>
型パラメーター:
T - 記述子の型
既知の直属サブクラス
CookieDescriptor, FieldDescriptor, LinkDescriptor, ParameterDescriptor, RequestPartDescriptor
public abstract class IgnorableDescriptor<T extends IgnorableDescriptor<T>> extends AbstractDescriptor<T>
無視できるアイテムの記述子の基本クラス。
作成者:
Andy Wilkinson

  • コンストラクターの詳細

    • IgnorableDescriptor

      public IgnorableDescriptor()

  • メソッドの詳細

    • ignored

      public final T ignored()
      記述された項目を無視するようにマークします。無視された項目は、生成されたドキュメントには含まれません。
      戻り値:
      記述子

    • isIgnored

      public final boolean isIgnored()
      説明されているアイテムを無視するかどうか、つまりドキュメントに含めないかどうかを返します。
      戻り値:
      アイテムを無視する必要がある場合は true、そうでない場合は false。