Interface StateSetNameAction

All Superinterfaces:
ResourceUpdateAction<StateUpdateAction>, StateUpdateAction

public interface StateSetNameAction extends StateUpdateAction
StateSetNameAction
Example to create an instance using the builder pattern

     StateSetNameAction stateSetNameAction = StateSetNameAction.builder()
             .name(nameBuilder -> nameBuilder)
             .build()
 
  • Field Details

  • Method Details

    • getName

      @NotNull @Valid @NotNull @Valid LocalizedString getName()

      Value to set. If the new value is the same as the current value, an InvalidOperation error is returned.

      Set to an empty object to remove any existing value.

      Returns:
      name
    • setName

      void setName(LocalizedString name)

      Value to set. If the new value is the same as the current value, an InvalidOperation error is returned.

      Set to an empty object to remove any existing value.

      Parameters:
      name - value to be set
    • of

      static StateSetNameAction of()
      factory method
      Returns:
      instance of StateSetNameAction
    • of

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

      StateSetNameAction copyDeep()
      Specified by:
      copyDeep in interface StateUpdateAction
    • deepCopy

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

      static StateSetNameActionBuilder builder()
      builder factory method for StateSetNameAction
      Returns:
      builder
    • builder

      static StateSetNameActionBuilder builder(StateSetNameAction template)
      create builder for StateSetNameAction instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder
    • withStateSetNameAction

      default <T> T withStateSetNameAction(Function<StateSetNameAction,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value
    • typeReference

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