Package org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021

Class IgpPrefixEventBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.IgpPrefixEventBuilder
@Generated("mdsal-binding-generator") public class IgpPrefixEventBuilder extends Object
Class that builds IgpPrefixEvent 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: 

   
     IgpPrefixEvent createIgpPrefixEvent(int fooXyzzy, int barBaz) {
         return new IgpPrefixEventBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • IgpPrefixEventBuilder

      public IgpPrefixEventBuilder()
      Construct an empty builder.

    • IgpPrefixEventBuilder

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

    • IgpPrefixEventBuilder

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

    • getIgpEventType

      public IgpEventType getIgpEventType()
      Return current value associated with the property corresponding to IgpPrefixEvent.getIgpEventType().
      Returns:
      current value

    • getL3UnicastIgpTopology

      public L3UnicastIgpTopology getL3UnicastIgpTopology()
      Return current value associated with the property corresponding to L3UnicastIgpTopologyType.getL3UnicastIgpTopology().
      Returns:
      current value

    • getNodeRef

      public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId getNodeRef()
      Return current value associated with the property corresponding to IgpPrefixEvent.getNodeRef().
      Returns:
      current value

    • getPrefix

      public Prefix getPrefix()
      Return current value associated with the property corresponding to IgpPrefixEvent.getPrefix().
      Returns:
      current value

    • getTopologyRef

      public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId getTopologyRef()
      Return current value associated with the property corresponding to IgpPrefixEvent.getTopologyRef().
      Returns:
      current value

    • augmentation

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

    • setIgpEventType

      public IgpPrefixEventBuilder setIgpEventType(IgpEventType value)
      Set the property corresponding to IgpPrefixEvent.getIgpEventType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setL3UnicastIgpTopology

      public IgpPrefixEventBuilder setL3UnicastIgpTopology(L3UnicastIgpTopology value)
      Set the property corresponding to L3UnicastIgpTopologyType.getL3UnicastIgpTopology() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setNodeRef

      public IgpPrefixEventBuilder setNodeRef(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.NodeId value)
      Set the property corresponding to IgpPrefixEvent.getNodeRef() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPrefix

      public IgpPrefixEventBuilder setPrefix(Prefix value)
      Set the property corresponding to IgpPrefixEvent.getPrefix() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTopologyRef

      public IgpPrefixEventBuilder setTopologyRef(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId value)
      Set the property corresponding to IgpPrefixEvent.getTopologyRef() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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