Interface Property

All Known Implementing Classes:
ImmutableProperty

@Immutable public interface Property
Models a property in a DTO.
  • Method Details

    • builder

      static ImmutableProperty.Builder builder()
      Returns a builder for this type.
      Returns:
      a builder for this type
    • builderFrom

      static 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