Class Payload


  • public class Payload
    extends java.lang.Object
    Models a payload value for a bucket in a test, generally meant to have one kind of value per bucket.
    • Field Detail

      • EMPTY_PAYLOAD

        public static final Payload EMPTY_PAYLOAD
      • PAYLOAD_OVERWRITE_EXCEPTION

        public static final java.lang.String PAYLOAD_OVERWRITE_EXCEPTION
        See Also:
        Constant Field Values
    • Constructor Detail

      • Payload

        public Payload​(java.lang.String value)
      • Payload

        public Payload​(java.lang.Double value)
      • Payload

        public Payload​(java.lang.Long value)
      • Payload

        public Payload​(java.util.Map<java.lang.String,​java.lang.Object> value)
      • Payload

        public Payload​(com.fasterxml.jackson.databind.JsonNode value)
      • Payload

        public Payload​(java.lang.String[] values)
      • Payload

        public Payload​(java.lang.Double[] values)
      • Payload

        public Payload​(java.lang.Long[] values)
      • Payload

        public Payload()
      • Payload

        public Payload​(@Nonnull
                       Payload other)
    • Method Detail

      • getDoubleValue

        @Nullable
        public java.lang.Double getDoubleValue()
      • setDoubleValue

        public void setDoubleValue​(@Nullable
                                   java.lang.Double doubleValue)
      • getDoubleArray

        @Nullable
        public java.lang.Double[] getDoubleArray()
      • setDoubleArray

        public void setDoubleArray​(@Nullable
                                   java.lang.Double[] doubleArray)
      • getLongValue

        @Nullable
        public java.lang.Long getLongValue()
      • setLongValue

        public void setLongValue​(@Nullable
                                 java.lang.Long longValue)
      • getLongArray

        @Nullable
        public java.lang.Long[] getLongArray()
      • setLongArray

        public void setLongArray​(@Nullable
                                 java.lang.Long[] longArray)
      • getStringValue

        @Nullable
        public java.lang.String getStringValue()
      • setStringValue

        public void setStringValue​(@Nullable
                                   java.lang.String stringValue)
      • getStringArray

        @Nullable
        public java.lang.String[] getStringArray()
      • setStringArray

        public void setStringArray​(@Nullable
                                   java.lang.String[] stringArray)
      • getJson

        @Nullable
        public com.fasterxml.jackson.databind.JsonNode getJson()
      • setJson

        public void setJson​(@Nullable
                            com.fasterxml.jackson.databind.JsonNode json)
      • getMap

        @Nullable
        public java.util.Map<java.lang.String,​java.lang.Object> getMap()
      • setMap

        public void setMap​(@Nullable
                           java.util.Map<java.lang.String,​java.lang.Object> map)
      • toString

        @Nonnull
        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • fetchPayloadType

        @Nonnull
        public java.util.Optional<PayloadType> fetchPayloadType()
        infers payloadtype based on the value that is set.
        Returns:
        payloadType unless emptyPayload
      • fetchType

        @Nonnull
        @Deprecated
        public java.lang.String fetchType()
        Deprecated.
        use fetchPayloadType
        Returns:
        the payload type as a string. Used by Proctor Webapp.
      • sameType

        public boolean sameType​(@Nullable
                                Payload other)
      • numFieldsDefined

        public int numFieldsDefined()
      • fetchAValue

        @CheckForNull
        public java.lang.Object fetchAValue()
        Returns:
        "the" value of this Payload, stuffed into an Object. This is used for evaluating the "validator" portion of a PayloadSpecification against these Payloads.

        We don't want the JsonSerializer to know about this, so renamed to not begin with "get".

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object