Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.port.desc._case.multipart.reply.port.desc

Class PortsBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.port.desc._case.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(PortGrouping arg)
      Construct a new builder initialized from specified PortGrouping.
      Parameters:
      arg - PortGrouping 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 PortGrouping.getAdvertisedFeatures().
      Returns:
      current value

    • getAdvertisedFeaturesV10

      public PortFeaturesV10 getAdvertisedFeaturesV10()
      Return current value associated with the property corresponding to PortGrouping.getAdvertisedFeaturesV10().
      Returns:
      current value

    • getConfig

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

    • getConfigV10

      public PortConfigV10 getConfigV10()
      Return current value associated with the property corresponding to PortGrouping.getConfigV10().
      Returns:
      current value

    • getCurrSpeed

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

    • getCurrentFeatures

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

    • getCurrentFeaturesV10

      public PortFeaturesV10 getCurrentFeaturesV10()
      Return current value associated with the property corresponding to PortGrouping.getCurrentFeaturesV10().
      Returns:
      current value

    • getHwAddr

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

    • getMaxSpeed

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

    • getName

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

    • getPeerFeatures

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

    • getPeerFeaturesV10

      public PortFeaturesV10 getPeerFeaturesV10()
      Return current value associated with the property corresponding to PortGrouping.getPeerFeaturesV10().
      Returns:
      current value

    • getPortNo

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

    • getState

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

    • getStateV10

      public PortStateV10 getStateV10()
      Return current value associated with the property corresponding to PortGrouping.getStateV10().
      Returns:
      current value

    • getSupportedFeatures

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

    • getSupportedFeaturesV10

      public PortFeaturesV10 getSupportedFeaturesV10()
      Return current value associated with the property corresponding to PortGrouping.getSupportedFeaturesV10().
      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 PortGrouping.getAdvertisedFeatures() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setAdvertisedFeaturesV10

      public PortsBuilder setAdvertisedFeaturesV10(PortFeaturesV10 value)
      Set the property corresponding to PortGrouping.getAdvertisedFeaturesV10() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setConfig

      public PortsBuilder setConfig(PortConfig value)
      Set the property corresponding to PortGrouping.getConfig() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setConfigV10

      public PortsBuilder setConfigV10(PortConfigV10 value)
      Set the property corresponding to PortGrouping.getConfigV10() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setCurrSpeed

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

    • setCurrentFeatures

      public PortsBuilder setCurrentFeatures(PortFeatures value)
      Set the property corresponding to PortGrouping.getCurrentFeatures() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setCurrentFeaturesV10

      public PortsBuilder setCurrentFeaturesV10(PortFeaturesV10 value)
      Set the property corresponding to PortGrouping.getCurrentFeaturesV10() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setHwAddr

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

    • setMaxSpeed

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

    • setName

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

    • setPeerFeatures

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

    • setPeerFeaturesV10

      public PortsBuilder setPeerFeaturesV10(PortFeaturesV10 value)
      Set the property corresponding to PortGrouping.getPeerFeaturesV10() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPortNo

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

    • setState

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

    • setStateV10

      public PortsBuilder setStateV10(PortStateV10 value)
      Set the property corresponding to PortGrouping.getStateV10() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSupportedFeatures

      public PortsBuilder setSupportedFeatures(PortFeatures value)
      Set the property corresponding to PortGrouping.getSupportedFeatures() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSupportedFeaturesV10

      public PortsBuilder setSupportedFeaturesV10(PortFeaturesV10 value)
      Set the property corresponding to PortGrouping.getSupportedFeaturesV10() 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.