Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.multipart.reply.multipart.reply.body.multipart.reply.port.desc

Class PortsBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.multipart.reply.multipart.reply.body.multipart.reply.port.desc.PortsBuilder
@Generated("mdsal-binding-generator") public class PortsBuilder extends Object
Class that builds Ports instances. Overall design of the class is that of a fluent interface, where method chaining is used.

In general, this class is supposed to be used like this template: 

   
     Ports createPorts(int fooXyzzy, int barBaz) {
         return new PortsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

This pattern is supported by the immutable nature of Ports, as instances can be freely passed around without worrying about synchronization issues.

As a side note: method chaining results in:

  • very efficient Java bytecode, as the method invocation result, in this case the Builder reference, is on the stack, so further method invocations just need to fill method arguments for the next method invocation, which is terminated by build(), which is then returned from the method
  • better understanding by humans, as the scope of mutable state (the builder) is kept to a minimum and is very localized
  • better optimization opportunities, as the object scope is minimized in terms of invocation (rather than method) stack, making escape analysis a lot easier. Given enough compiler (JIT/AOT) prowess, the cost of th builder object can be completely eliminated
See Also:

  • Constructor Details

    • PortsBuilder

      public PortsBuilder()
      Construct an empty builder.

    • PortsBuilder

      public PortsBuilder(FlowCapablePort arg)
      Construct a new builder initialized from specified FlowCapablePort.
      Parameters:
      arg - FlowCapablePort from which the builder should be initialized

    • PortsBuilder

      public PortsBuilder(CommonPort arg)
      Construct a new builder initialized from specified CommonPort.
      Parameters:
      arg - CommonPort from which the builder should be initialized

    • PortsBuilder

      public PortsBuilder(Queues arg)
      Construct a new builder initialized from specified Queues.
      Parameters:
      arg - Queues from which the builder should be initialized

    • PortsBuilder

      public PortsBuilder(Ports base)
      Construct a builder initialized with state from specified Ports.
      Parameters:
      base - Ports from which the builder should be initialized

  • Method Details

    • fieldsFrom

      public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
      Set fields from given grouping argument. Valid argument is instance of one of following types:
      Parameters:
      arg - grouping object
      Throws:
      IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

    • getAdvertisedFeatures

      public PortFeatures getAdvertisedFeatures()
      Return current value associated with the property corresponding to CommonPort.getAdvertisedFeatures().
      Returns:
      current value

    • getConfiguration

      public PortConfig getConfiguration()
      Return current value associated with the property corresponding to CommonPort.getConfiguration().
      Returns:
      current value

    • getCurrentFeature

      public PortFeatures getCurrentFeature()
      Return current value associated with the property corresponding to FlowCapablePort.getCurrentFeature().
      Returns:
      current value

    • getCurrentSpeed

      public org.opendaylight.yangtools.yang.common.Uint32 getCurrentSpeed()
      Return current value associated with the property corresponding to FlowCapablePort.getCurrentSpeed().
      Returns:
      current value

    • getHardwareAddress

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getHardwareAddress()
      Return current value associated with the property corresponding to CommonPort.getHardwareAddress().
      Returns:
      current value

    • getMaximumSpeed

      public org.opendaylight.yangtools.yang.common.Uint32 getMaximumSpeed()
      Return current value associated with the property corresponding to FlowCapablePort.getMaximumSpeed().
      Returns:
      current value

    • getName

      public String getName()
      Return current value associated with the property corresponding to FlowCapablePort.getName().
      Returns:
      current value

    • getPeerFeatures

      public PortFeatures getPeerFeatures()
      Return current value associated with the property corresponding to FlowCapablePort.getPeerFeatures().
      Returns:
      current value

    • getPortNumber

      public PortNumberUni getPortNumber()
      Return current value associated with the property corresponding to CommonPort.getPortNumber().
      Returns:
      current value

    • getQueue

      public Map<QueueKey,Queue> getQueue()
      Return current value associated with the property corresponding to Queues.getQueue().
      Returns:
      current value

    • getState

      public State getState()
      Return current value associated with the property corresponding to FlowCapablePort.getState().
      Returns:
      current value

    • getSupported

      public PortFeatures getSupported()
      Return current value associated with the property corresponding to FlowCapablePort.getSupported().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ports>> E$$ augmentation(Class<E$$> augmentationType)
      Return the specified augmentation, if it is present in this builder.
      Type Parameters:
      E$$ - augmentation type
      Parameters:
      augmentationType - augmentation type class
      Returns:
      Augmentation object from this builder, or null if not present
      Throws:
      NullPointerException - if augmentType is null

    • setAdvertisedFeatures

      public PortsBuilder setAdvertisedFeatures(PortFeatures value)
      Set the property corresponding to CommonPort.getAdvertisedFeatures() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setConfiguration

      public PortsBuilder setConfiguration(PortConfig value)
      Set the property corresponding to CommonPort.getConfiguration() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setCurrentFeature

      public PortsBuilder setCurrentFeature(PortFeatures value)
      Set the property corresponding to FlowCapablePort.getCurrentFeature() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setCurrentSpeed

      public PortsBuilder setCurrentSpeed(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to FlowCapablePort.getCurrentSpeed() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setHardwareAddress

      public PortsBuilder setHardwareAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
      Set the property corresponding to CommonPort.getHardwareAddress() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMaximumSpeed

      public PortsBuilder setMaximumSpeed(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to FlowCapablePort.getMaximumSpeed() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setName

      public PortsBuilder setName(String value)
      Set the property corresponding to FlowCapablePort.getName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPeerFeatures

      public PortsBuilder setPeerFeatures(PortFeatures value)
      Set the property corresponding to FlowCapablePort.getPeerFeatures() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPortNumber

      public PortsBuilder setPortNumber(PortNumberUni value)
      Set the property corresponding to CommonPort.getPortNumber() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setQueue

      public PortsBuilder setQueue(Map<QueueKey,Queue> values)
      Set the property corresponding to Queues.getQueue() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setState

      public PortsBuilder setState(State value)
      Set the property corresponding to FlowCapablePort.getState() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSupported

      public PortsBuilder setSupported(PortFeatures value)
      Set the property corresponding to FlowCapablePort.getSupported() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

      public PortsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ports> augmentation)
      Add an augmentation to this builder's product.
      Parameters:
      augmentation - augmentation to be added
      Returns:
      this builder
      Throws:
      NullPointerException - if augmentation is null

    • removeAugmentation

      public PortsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ports>> augmentationType)
      Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
      Parameters:
      augmentationType - augmentation type to be removed
      Returns:
      this builder

    • build

      public @NonNull Ports build()
      A new Ports instance.
      Returns:
      A new Ports instance.