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

Class IgpNodeEventBuilder

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

   
     IgpNodeEvent createIgpNodeEvent(int fooXyzzy, int barBaz) {
         return new IgpNodeEventBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • IgpNodeEventBuilder

      public IgpNodeEventBuilder()
      Construct an empty builder.

    • IgpNodeEventBuilder

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

    • IgpNodeEventBuilder

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

    • IgpNodeEventBuilder

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

    • IgpNodeEventBuilder

      public IgpNodeEventBuilder(IgpNodeEvent base)
      Construct a builder initialized with state from specified IgpNodeEvent.
      Parameters:
      base - IgpNodeEvent 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 IgpNodeEvent.getIgpEventType().
      Returns:
      current value

    • getIgpNodeAttributes

      public IgpNodeAttributes getIgpNodeAttributes()
      Return current value associated with the property corresponding to IgpNodeAttributes.getIgpNodeAttributes().
      Returns:
      current value

    • getL3UnicastIgpTopology

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

    • getNodeId

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

    • getSupportingNode

      public Map<org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.node.attributes.SupportingNodeKey,org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.node.attributes.SupportingNode> getSupportingNode()
      Return current value associated with the property corresponding to NodeAttributes.getSupportingNode().
      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 IgpNodeEvent.getTopologyRef().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpNodeEvent>> 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 IgpNodeEventBuilder setIgpEventType(IgpEventType value)
      Set the property corresponding to IgpNodeEvent.getIgpEventType() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIgpNodeAttributes

      public IgpNodeEventBuilder setIgpNodeAttributes(IgpNodeAttributes value)
      Set the property corresponding to IgpNodeAttributes.getIgpNodeAttributes() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setL3UnicastIgpTopology

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

    • setNodeId

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

    • setSupportingNode

      public IgpNodeEventBuilder setSupportingNode(Map<org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.node.attributes.SupportingNodeKey,org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.node.attributes.SupportingNode> values)
      Set the property corresponding to NodeAttributes.getSupportingNode() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setTopologyRef

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

    • addAugmentation

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