Packages

class ApiModelProperty extends Annotation with Annotation with ClassfileAnnotation

Annotations
@Target() @Retention()
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 defaultValue(): String

    Default value of the property.

    Default value of the property. It can be a integer, number, bool, string or JSON string representation of an array or object.

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

    Provide a human readable synopsis of this property

    Provide a human readable synopsis of this property

    Annotations
    @AnnotationDefault()
  6. abstract def example(): String

    Example value of the property

    Example value of the property

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

    Whether or not the property should be hidden from the Swagger documentation.

    Whether or not the property should be hidden from the Swagger documentation.

    returns

    true if it should be hidden. Otherwise false

    Annotations
    @AnnotationDefault()
  8. abstract def maximumValue(): Double

    Maximum value of the property

    Maximum value of the property

    Annotations
    @AnnotationDefault()
  9. abstract def minimumValue(): Double

    Minimum value of the property

    Minimum value of the property

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

    long description of the property

    long description of the property

    Annotations
    @AnnotationDefault()
  11. 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()
  12. 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()

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from ClassfileAnnotation

Inherited from StaticAnnotation

Inherited from Annotation

Inherited from Annotation

Inherited from AnyRef

Inherited from Any

Ungrouped