Packages

class ApiModelProperty extends Annotation with Annotation with ClassfileAnnotation

Linear Supertypes
ClassfileAnnotation, StaticAnnotation, Annotation, Annotation, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ApiModelProperty
  2. ClassfileAnnotation
  3. StaticAnnotation
  4. Annotation
  5. Annotation
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ApiModelProperty()

Abstract Value Members

  1. abstract def access(): String

    specify an optional access value for filtering in a Filter implementation.

    specify an optional access value for filtering in a Filter implementation. This allows you to hide certain parameters if a user doesn't have access to them

    Annotations
    @AnnotationDefault()
  2. abstract def allowableValues(): String

    If the values that can be set are restricted, they can be set here.

    If the values that can be set are restricted, they can be set here. In the form of a comma separated list registered, active, closed.

    returns

    the allowable values

    Annotations
    @AnnotationDefault()
  3. abstract def annotationType(): Class[_ <: Annotation]
    Definition Classes
    Annotation
  4. abstract def description(): String

    Provide a human readable synopsis of this property

    Provide a human readable synopsis of this property

    Annotations
    @AnnotationDefault()
  5. abstract def notes(): String

    long description of the property

    long description of the property

    Annotations
    @AnnotationDefault()
  6. abstract def position(): Int

    allows explicitly ordering the property in the model.

    allows explicitly ordering the property in the model. Since reflection has no guarantee on ordering, you should specify property order to keep models consistent across different VM implementations and versions.

    Annotations
    @AnnotationDefault()
  7. abstract def required(): Boolean

    Whether or not the property is required, defaults to true.

    Whether or not the property is required, defaults to true.

    returns

    true if required, false otherwise

    Annotations
    @AnnotationDefault()