Class ParameterExampleContract


  • public final class ParameterExampleContract
    extends Object
    Parameter example.
    • Constructor Detail

      • ParameterExampleContract

        public ParameterExampleContract()
    • Method Detail

      • summary

        public String summary()
        Get the summary property: Short description for the example.
        Returns:
        the summary value.
      • withSummary

        public ParameterExampleContract withSummary​(String summary)
        Set the summary property: Short description for the example.
        Parameters:
        summary - the summary value to set.
        Returns:
        the ParameterExampleContract object itself.
      • description

        public String description()
        Get the description property: Long description for the example.
        Returns:
        the description value.
      • withDescription

        public ParameterExampleContract withDescription​(String description)
        Set the description property: Long description for the example.
        Parameters:
        description - the description value to set.
        Returns:
        the ParameterExampleContract object itself.
      • value

        public Object value()
        Get the value property: Example value. May be a primitive value, or an object.
        Returns:
        the value value.
      • withValue

        public ParameterExampleContract withValue​(Object value)
        Set the value property: Example value. May be a primitive value, or an object.
        Parameters:
        value - the value value to set.
        Returns:
        the ParameterExampleContract object itself.
      • externalValue

        public String externalValue()
        Get the externalValue property: A URL that points to the literal example.
        Returns:
        the externalValue value.
      • withExternalValue

        public ParameterExampleContract withExternalValue​(String externalValue)
        Set the externalValue property: A URL that points to the literal example.
        Parameters:
        externalValue - the externalValue value to set.
        Returns:
        the ParameterExampleContract object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.