Package org.opentcs.access.to.order
Class DestinationCreationTO
java.lang.Object
org.opentcs.access.to.CreationTO
org.opentcs.access.to.order.DestinationCreationTO
- All Implemented Interfaces:
Serializable
A transfer object describing a destination of a drive order.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionDestinationCreationTO
(String destLocationName, String destOperation) Creates a new instance. -
Method Summary
Modifier and TypeMethodDescriptionReturns the destination location (or point) name.Returns the operation to be performed at the destination.withDestLocationName
(String desLocationName) Creates a copy of this object with the given destination location (or point) name.withDestOperation
(String destOperation) Creates a copy of this object with the given operation to be performed at the destination.Creates a copy of this object with the given name.withProperties
(Map<String, String> properties) Creates a copy of this object with the given properties.withProperty
(String key, String value) Creates a copy of this object and adds the given property.Methods inherited from class org.opentcs.access.to.CreationTO
getModifiableProperties, getName, getProperties, listWithAppendix, mapWithMapping, propertiesWith
-
Constructor Details
-
DestinationCreationTO
Creates a new instance.- Parameters:
destLocationName
- The name of the destination location (or destination point).destOperation
- The operation to be performed at the destination.
-
-
Method Details
-
withName
Creates a copy of this object with the given name.- Overrides:
withName
in classCreationTO
- Parameters:
name
- the new name of the instance.- Returns:
- A copy of this object, differing in the given value.
-
withProperties
Creates a copy of this object with the given properties.- Overrides:
withProperties
in classCreationTO
- Parameters:
properties
- The new properties.- Returns:
- A copy of this object, differing in the given value.
-
withProperty
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 classCreationTO
- 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.
-
getDestLocationName
Returns the destination location (or point) name.- Returns:
- The destination location (or point) name.
-
withDestLocationName
Creates a copy of this object with the given destination location (or point) name.- Parameters:
desLocationName
- The destination location (or point) name.- Returns:
- A copy of this object, differing in the given destination.
-
getDestOperation
Returns the operation to be performed at the destination.- Returns:
- The operation to be performed at the destination.
-
withDestOperation
Creates a copy of this object with the given operation to be performed at the destination.- Parameters:
destOperation
- The operation.- Returns:
- A copy of this object, differing in the given destination operation.
-