Package org.opentcs.access.to.model

Klasse BlockCreationTO

java.lang.Object
org.opentcs.access.to.CreationTO
org.opentcs.access.to.model.BlockCreationTO
Alle implementierten Schnittstellen:
Serializable
public class BlockCreationTO extends CreationTO implements Serializable
A transfer object describing a block in the plant model.
Siehe auch:

  • Konstruktordetails

    • BlockCreationTO

      public BlockCreationTO(String name)
      Creates a new instance.
      Parameter:
      name - The name of this block.

  • Methodendetails

    • withName

      public BlockCreationTO withName(@Nonnull String name)
      Creates a copy of this object with the given name.
      Setzt außer Kraft:
      withName in Klasse CreationTO
      Parameter:
      name - The new name.
      Gibt zurück:
      A copy of this object, differing in the given name.

    • withProperties

      public BlockCreationTO withProperties(@Nonnull Map<String,String> properties)
      Creates a copy of this object with the given properties.
      Setzt außer Kraft:
      withProperties in Klasse CreationTO
      Parameter:
      properties - The new properties.
      Gibt zurück:
      A copy of this object, differing in the given properties.

    • withProperty

      public BlockCreationTO withProperty(@Nonnull String key, @Nonnull 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.
      Setzt außer Kraft:
      withProperty in Klasse CreationTO
      Parameter:
      key - the key.
      value - the value
      Gibt zurück:
      A copy of this object that either includes the given entry in it's current properties, if value != null or excludes the entry otherwise.

    • getType

      @Nonnull public Block.Type getType()
      Returns the type of this block.
      Gibt zurück:
      The type of this block.

    • withType

      public BlockCreationTO withType(@Nonnull Block.Type type)
      Creates a copy of this object with the given type.
      Parameter:
      type - The new type.
      Gibt zurück:
      A copy of this object, differing in the given type.

    • getMemberNames

      @Nonnull public Set<String> getMemberNames()
      Returns the names of this block's members.
      Gibt zurück:
      The names of this block's members.

    • withMemberNames

      public BlockCreationTO withMemberNames(@Nonnull Set<String> memberNames)
      Creates a copy of this object with the given members.
      Parameter:
      memberNames - The names of the block's members.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • getLayout

      public BlockCreationTO.Layout getLayout()
      Returns the information regarding the grahical representation of this block.
      Gibt zurück:
      The information regarding the grahical representation of this block.

    • withLayout

      public BlockCreationTO withLayout(BlockCreationTO.Layout layout)
      Creates a copy of this object, with the given layout.
      Parameter:
      layout - The value to be set in the copy.
      Gibt zurück:
      A copy of this object, differing in the given value.

    • toString

      public String toString()
      Setzt außer Kraft:
      toString in Klasse Object