Class CommonField


  • public class CommonField
    extends Object
    CommonField
    • Constructor Detail

      • CommonField

        public CommonField()
    • Method Detail

      • name

        public CommonField name​(String name)
        Name of the field. For example, Name of External Platform.
        Parameters:
        name - Name of the field. For example, Name of External Platform.
        Returns:
        the current CommonField instance, allowing for method chaining
      • getName

        public String getName()
        Name of the field. For example, Name of External Platform.
        Returns:
        name Name of the field. For example, Name of External Platform.
      • setName

        public void setName​(String name)
        Name of the field. For example, Name of External Platform.
        Parameters:
        name - Name of the field. For example, Name of External Platform.
      • version

        public CommonField version​(String version)
        Version of the field. For example, Version of External Platform.
        Parameters:
        version - Version of the field. For example, Version of External Platform.
        Returns:
        the current CommonField instance, allowing for method chaining
      • getVersion

        public String getVersion()
        Version of the field. For example, Version of External Platform.
        Returns:
        version Version of the field. For example, Version of External Platform.
      • setVersion

        public void setVersion​(String version)
        Version of the field. For example, Version of External Platform.
        Parameters:
        version - Version of the field. For example, Version of External Platform.
      • includeNullValues

        public CommonField includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.
      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.
      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
      • equals

        public boolean equals​(Object o)
        Return true if this CommonField object is equal to o.
        Overrides:
        equals in class Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • getExplicitNulls

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.
      • fromJson

        public static CommonField fromJson​(String jsonString)
                                    throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of CommonField given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of CommonField
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to CommonField
      • toJson

        public String toJson()
                      throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of CommonField to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException