Package org.opentcs.access.to.model

Class LocationTypeCreationTO

java.lang.Object
org.opentcs.access.to.CreationTO
org.opentcs.access.to.model.LocationTypeCreationTO
All Implemented Interfaces:
java.io.Serializable
public class LocationTypeCreationTO
extends CreationTO
implements java.io.Serializable
A transfer object describing a location type in the plant model.
See Also:
Serialized Form

  • Constructor Details

    • LocationTypeCreationTO

      public LocationTypeCreationTO​(@Nonnull java.lang.String name)
      Creates a new instance.
      Parameters:
      name - The name of this location type.

  • Method Details

    • getAllowedOperations

      @Nonnull public java.util.List<java.lang.String> getAllowedOperations()
      Returns the allowed operations for this location type.
      Returns:
      The allowed operations for this location type.

    • withAllowedOperations

      public LocationTypeCreationTO withAllowedOperations​(@Nonnull java.util.List<java.lang.String> allowedOperations)
      Creates a copy of this object with the given allowed operations.
      Parameters:
      allowedOperations - the new allowed operations.
      Returns:
      A copy of this object, differing in the given value.

    • getAllowedPeripheralOperations

      @Nonnull public java.util.List<java.lang.String> getAllowedPeripheralOperations()
      Returns the allowed peripheral operations for this location type.
      Returns:
      The allowed peripheral operations for this location type.

    • withAllowedPeripheralOperations

      public LocationTypeCreationTO withAllowedPeripheralOperations​(@Nonnull java.util.List<java.lang.String> allowedPeripheralOperations)
      Creates a copy of this object with the given allowed peripheral operations.
      Parameters:
      allowedPeripheralOperations - the new allowed peripheral operations.
      Returns:
      A copy of this object, differing in the given value.

    • withName

      public LocationTypeCreationTO withName​(@Nonnull java.lang.String name)
      Creates a copy of this object with the given name.
      Overrides:
      withName in class CreationTO
      Parameters:
      name - The new name.
      Returns:
      A copy of this object, differing in the given name.

    • withProperties

      public LocationTypeCreationTO withProperties​(@Nonnull java.util.Map<java.lang.String,​java.lang.String> properties)
      Creates a copy of this object with the given properties.
      Overrides:
      withProperties in class CreationTO
      Parameters:
      properties - The new properties.
      Returns:
      A copy of this object, differing in the given properties.

    • withProperty

      public LocationTypeCreationTO withProperty​(@Nonnull java.lang.String key, @Nonnull java.lang.String value)
      Creates a copy of this object and adds the given property. If value == null, then the key-value pair is removed from the properties.
      Overrides:
      withProperty in class CreationTO
      Parameters:
      key - the key.
      value - the value
      Returns:
      A copy of this object that either includes the given entry in it's current properties, if value != null or excludes the entry otherwise.

    • getLayout

      public LocationTypeCreationTO.Layout getLayout()
      Returns the information regarding the grahical representation of this location type.
      Returns:
      The information regarding the grahical representation of this location type.

    • withLayout

      public LocationTypeCreationTO withLayout​(LocationTypeCreationTO.Layout layout)
      Creates a copy of this object, with the given layout.
      Parameters:
      layout - The value to be set in the copy.
      Returns:
      A copy of this object, differing in the given value.

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object