Package com.commercetools.history.models.label

Interface CustomObjectLabel

All Superinterfaces:
Label
public interface CustomObjectLabel extends Label
CustomObjectLabel
Example to create an instance using the builder pattern 

     CustomObjectLabel customObjectLabel = CustomObjectLabel.builder()
             .key("{key}")
             .container("{container}")
             .build()

  • Field Details

    • CUSTOM_OBJECT_LABEL

      static final String CUSTOM_OBJECT_LABEL
      discriminator value for CustomObjectLabel
      See Also:

  • Method Details

    • getType

      @NotNull @NotNull String getType()
      Specified by:
      getType in interface Label
      Returns:
      type

    • getKey

      @NotNull @NotNull String getKey()

      User-defined unique identifier of the CustomObject within the defined container.

      Returns:
      key

    • getContainer

      @NotNull @NotNull String getContainer()

      Namespace to group Custom Objects.

      Returns:
      container

    • setKey

      void setKey(String key)

      User-defined unique identifier of the CustomObject within the defined container.

      Parameters:
      key - value to be set

    • setContainer

      void setContainer(String container)

      Namespace to group Custom Objects.

      Parameters:
      container - value to be set

    • of

      static CustomObjectLabel of()
      factory method
      Returns:
      instance of CustomObjectLabel

    • of

      static CustomObjectLabel of(CustomObjectLabel template)
      factory method to create a shallow copy CustomObjectLabel
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • deepCopy

      @Nullable static CustomObjectLabel deepCopy(@Nullable CustomObjectLabel template)
      factory method to create a deep copy of CustomObjectLabel
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static CustomObjectLabelBuilder builder()
      builder factory method for CustomObjectLabel
      Returns:
      builder

    • builder

      static CustomObjectLabelBuilder builder(CustomObjectLabel template)
      create builder for CustomObjectLabel instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withCustomObjectLabel

      default <T> T withCustomObjectLabel(Function<CustomObjectLabel,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<CustomObjectLabel> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference