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

Class IgpLinkEventBuilder

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

   
     IgpLinkEvent createIgpLinkEvent(int fooXyzzy, int barBaz) {
         return new IgpLinkEventBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • IgpLinkEventBuilder

      public IgpLinkEventBuilder()
      Construct an empty builder.

    • IgpLinkEventBuilder

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

    • IgpLinkEventBuilder

      public IgpLinkEventBuilder(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkAttributes arg)
      Construct a new builder initialized from specified LinkAttributes.
      Parameters:
      arg - LinkAttributes from which the builder should be initialized

    • IgpLinkEventBuilder

      public IgpLinkEventBuilder(IgpLinkAttributes arg)
      Construct a new builder initialized from specified IgpLinkAttributes.
      Parameters:
      arg - org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.IgpLinkAttributes from which the builder should be initialized

    • IgpLinkEventBuilder

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

    • getDestination

      public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.link.attributes.Destination getDestination()
      Return current value associated with the property corresponding to LinkAttributes.getDestination().
      Returns:
      current value

    • getIgpEventType

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

    • getIgpLinkAttributes

      public IgpLinkAttributes getIgpLinkAttributes()
      Return current value associated with the property corresponding to IgpLinkAttributes.getIgpLinkAttributes().
      Returns:
      current value

    • getL3UnicastIgpTopology

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

    • getLinkId

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

    • getSource

      public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.link.attributes.Source getSource()
      Return current value associated with the property corresponding to LinkAttributes.getSource().
      Returns:
      current value

    • getSupportingLink

      public Map<org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.link.attributes.SupportingLinkKey,org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.link.attributes.SupportingLink> getSupportingLink()
      Return current value associated with the property corresponding to LinkAttributes.getSupportingLink().
      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 IgpLinkEvent.getTopologyRef().
      Returns:
      current value

    • augmentation

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

    • setDestination

      public IgpLinkEventBuilder setDestination(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.link.attributes.Destination value)
      Set the property corresponding to LinkAttributes.getDestination() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIgpEventType

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

    • setIgpLinkAttributes

      public IgpLinkEventBuilder setIgpLinkAttributes(IgpLinkAttributes value)
      Set the property corresponding to IgpLinkAttributes.getIgpLinkAttributes() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setL3UnicastIgpTopology

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

    • setLinkId

      public IgpLinkEventBuilder setLinkId(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId value)
      Set the property corresponding to LinkAttributes.getLinkId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSource

      public IgpLinkEventBuilder setSource(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.link.attributes.Source value)
      Set the property corresponding to LinkAttributes.getSource() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSupportingLink

      public IgpLinkEventBuilder setSupportingLink(Map<org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.link.attributes.SupportingLinkKey,org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.link.attributes.SupportingLink> values)
      Set the property corresponding to LinkAttributes.getSupportingLink() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setTopologyRef

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

    • addAugmentation

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