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:
Serializable
A transfer object describing a location type in the plant model.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classContains information regarding the grahical representation of a location type. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the allowed operations for this location type.Returns the allowed peripheral operations for this location type.Returns the information regarding the grahical representation of this location type.toString()withAllowedOperations(List<String> allowedOperations) Creates a copy of this object with the given allowed operations.withAllowedPeripheralOperations(List<String> allowedPeripheralOperations) Creates a copy of this object with the given allowed peripheral operations.Creates a copy of this object, with the given layout.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
-
LocationTypeCreationTO
Creates a new instance.- Parameters:
name- The name of this location type.
-
-
Method Details
-
getAllowedOperations
Returns the allowed operations for this location type.- Returns:
- The allowed operations for this location type.
-
withAllowedOperations
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
Returns the allowed peripheral operations for this location type.- Returns:
- The allowed peripheral operations for this location type.
-
withAllowedPeripheralOperations
public LocationTypeCreationTO withAllowedPeripheralOperations(@Nonnull List<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
Creates a copy of this object with the given name.- Overrides:
withNamein classCreationTO- Parameters:
name- The new name.- Returns:
- A copy of this object, differing in the given name.
-
withProperties
Creates a copy of this object with the given properties.- Overrides:
withPropertiesin classCreationTO- Parameters:
properties- The new properties.- Returns:
- A copy of this object, differing in the given properties.
-
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:
withPropertyin 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.
-
getLayout
Returns the information regarding the grahical representation of this location type.- Returns:
- The information regarding the grahical representation of this location type.
-
withLayout
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
-