Package org.opentcs.access.to.model

Class ShapeLayoutElementCreationTO

java.lang.Object

org.opentcs.access.to.CreationTO

org.opentcs.access.to.model.ShapeLayoutElementCreationTO

All Implemented Interfaces:

java.io.Serializable

public class ShapeLayoutElementCreationTO
extends CreationTO
implements java.io.Serializable

A transfer object describing a shape layout element in the visual layout.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ShapeLayoutElementCreationTO(java.lang.String name)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
int	getLayer()	Returns the layer on which this shape layout element is to be displayed.
ShapeLayoutElementCreationTO	withLayer(int layer)	Creates a copy of this object with the given layer on which this shape layout element is to be displayed.
ShapeLayoutElementCreationTO	withName(java.lang.String name)	Creates a copy of this object with the given name.
ShapeLayoutElementCreationTO	withProperties(java.util.Map<java.lang.String,java.lang.String> properties)	Creates a copy of this object with the given properties.
ShapeLayoutElementCreationTO	withPropery(java.lang.String key, java.lang.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, withProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ShapeLayoutElementCreationTO

public ShapeLayoutElementCreationTO(java.lang.String name)

Creates a new instance.

Parameters:

name - The name of this shape layout element.

Method Details

withName

public ShapeLayoutElementCreationTO 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 value.

withProperties

public ShapeLayoutElementCreationTO 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.

withPropery

public ShapeLayoutElementCreationTO withPropery(@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.

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.

getLayer

public int getLayer()

Returns the layer on which this shape layout element is to be displayed.

Returns:

The layer on which this shape layout element is to be displayed.

withLayer

public ShapeLayoutElementCreationTO withLayer(int layer)

Creates a copy of this object with the given layer on which this shape layout element is to be displayed.

Parameters:

layer - the new layer.

Returns:

a copy of this object, differing in the given layer.