Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.bundle.add.message.grouping.bundle.inner.message.bundle.port.mod._case

Class PortModCaseDataBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.rev170124.bundle.add.message.grouping.bundle.inner.message.bundle.port.mod._case.PortModCaseDataBuilder
@Generated("mdsal-binding-generator") public class PortModCaseDataBuilder extends Object
Class that builds PortModCaseData 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: 

   
     PortModCaseData createPortModCaseData(int fooXyzzy, int barBaz) {
         return new PortModCaseDataBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

This pattern is supported by the immutable nature of PortModCaseData, 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

    • PortModCaseDataBuilder

      public PortModCaseDataBuilder()
      Construct an empty builder.

    • PortModCaseDataBuilder

      public PortModCaseDataBuilder(PortMod$G arg)
      Construct a new builder initialized from specified PortMod$G.
      Parameters:
      arg - PortMod$G from which the builder should be initialized

    • PortModCaseDataBuilder

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

    • PortModCaseDataBuilder

      public PortModCaseDataBuilder(PortModCaseData base)
      Construct a builder initialized with state from specified PortModCaseData.
      Parameters:
      base - PortModCaseData 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

    • getAdvertise

      public PortFeatures getAdvertise()
      Return current value associated with the property corresponding to PortMod$G.getAdvertise().
      Returns:
      current value

    • getAdvertiseV10

      public PortFeaturesV10 getAdvertiseV10()
      Return current value associated with the property corresponding to PortMod$G.getAdvertiseV10().
      Returns:
      current value

    • getConfig

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

    • getConfigV10

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

    • getHwAddress

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

    • getMask

      public PortConfig getMask()
      Return current value associated with the property corresponding to PortMod$G.getMask().
      Returns:
      current value

    • getMaskV10

      public PortConfigV10 getMaskV10()
      Return current value associated with the property corresponding to PortMod$G.getMaskV10().
      Returns:
      current value

    • getPortNo

      public PortNumber getPortNo()
      Return current value associated with the property corresponding to PortMod$G.getPortNo().
      Returns:
      current value

    • getVersion

      public org.opendaylight.yangtools.yang.common.Uint8 getVersion()
      Return current value associated with the property corresponding to OfHeader.getVersion().
      Returns:
      current value

    • getXid

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

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PortModCaseData>> 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

    • setAdvertise

      public PortModCaseDataBuilder setAdvertise(PortFeatures value)
      Set the property corresponding to PortMod$G.getAdvertise() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setAdvertiseV10

      public PortModCaseDataBuilder setAdvertiseV10(PortFeaturesV10 value)
      Set the property corresponding to PortMod$G.getAdvertiseV10() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setConfig

      public PortModCaseDataBuilder setConfig(PortConfig value)
      Set the property corresponding to PortMod$G.getConfig() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setConfigV10

      public PortModCaseDataBuilder setConfigV10(PortConfigV10 value)
      Set the property corresponding to PortMod$G.getConfigV10() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setHwAddress

      public PortModCaseDataBuilder setHwAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress value)
      Set the property corresponding to PortMod$G.getHwAddress() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMask

      public PortModCaseDataBuilder setMask(PortConfig value)
      Set the property corresponding to PortMod$G.getMask() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setMaskV10

      public PortModCaseDataBuilder setMaskV10(PortConfigV10 value)
      Set the property corresponding to PortMod$G.getMaskV10() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPortNo

      public PortModCaseDataBuilder setPortNo(PortNumber value)
      Set the property corresponding to PortMod$G.getPortNo() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setVersion

      public PortModCaseDataBuilder setVersion(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to OfHeader.getVersion() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setXid

      public PortModCaseDataBuilder setXid(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to OfHeader.getXid() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

      public PortModCaseDataBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PortModCaseData> 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 PortModCaseDataBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PortModCaseData>> 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 PortModCaseData build()
      A new PortModCaseData instance.
      Returns:
      A new PortModCaseData instance.