Package dk.mada.jaxrs.model

Interface Property

@Immutable public interface Property
Models a property in a DTO.

  • Method Summary

    Modifier and Type
    Method
    Description
    static dk.mada.jaxrs.model.ImmutableProperty.Builder
    builder()
    Returns a builder for this type.
    static dk.mada.jaxrs.model.ImmutableProperty.Builder
    builderFrom(Property other)
    Returns a builder for this type.
    Optional<String>
    description()
    Returns an optional description of the property.
    Optional<String>
    example()
    Returns an optional example for the property.
    String
    name()
    Returns the property name.
    Reference
    reference()
    Returns the property type.
    Validation
    validation()
    Returns the validation required for this property.

  • Method Details

    • builder

      static dk.mada.jaxrs.model.ImmutableProperty.Builder builder()
      Returns a builder for this type.
      Returns:
      a builder for this type

    • builderFrom

      static dk.mada.jaxrs.model.ImmutableProperty.Builder builderFrom(Property other)
      Returns a builder for this type.
      Parameters:
      other - the existing Property to create a builder from
      Returns:
      a builder for this type

    • name

      String name()
      Returns the property name.
      Returns:
      the property name

    • reference

      Reference reference()
      Returns the property type.
      Returns:
      the property type

    • description

      Optional<String> description()
      Returns an optional description of the property.
      Returns:
      an optional description of the property

    • example

      Optional<String> example()
      Returns an optional example for the property.
      Returns:
      an optional example for the property

    • validation

      Validation validation()
      Returns the validation required for this property.
      Returns:
      the validation required for this property