クラス ParameterDescriptor

java.lang.ObjectSE
org.springframework.restdocs.snippet.AbstractDescriptor<ParameterDescriptor>
org.springframework.restdocs.snippet.IgnorableDescriptor<ParameterDescriptor>
org.springframework.restdocs.request.ParameterDescriptor
public class ParameterDescriptor extends IgnorableDescriptor<ParameterDescriptor>
リクエストまたはパスパラメーターの記述子。
作成者:
Andy Wilkinson
関連事項:

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

    • ParameterDescriptor

      protected ParameterDescriptor(StringSE name)
      指定された name でパラメーターを記述する新しい ParameterDescriptor を作成します。
      パラメーター:
      name - パラメーターの名前

  • メソッドの詳細

    • optional

      public final ParameterDescriptor optional()
      パラメーターをオプションとしてマークします。
      戻り値:
      this

    • getName

      public final StringSE getName()
      この記述子によって記述されているパラメーターの名前を返します。
      戻り値:
      パラメーターの名前

    • isOptional

      public final boolean isOptional()
      記述されたパラメーターがオプションの場合は true を返し、そうでない場合は false を返します。
      戻り値:
      記述されたパラメーターがオプションの場合は true、それ以外の場合は false