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

Class TerminationPointEventBuilder

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

   
     TerminationPointEvent createTerminationPointEvent(int fooXyzzy, int barBaz) {
         return new TerminationPointEventBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • TerminationPointEventBuilder

      public TerminationPointEventBuilder()
      Construct an empty builder.

    • TerminationPointEventBuilder

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

    • TerminationPointEventBuilder

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

    • TerminationPointEventBuilder

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

    • TerminationPointEventBuilder

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

    • getIgpTerminationPointAttributes

      public IgpTerminationPointAttributes getIgpTerminationPointAttributes()
      Return current value associated with the property corresponding to IgpTerminationPointAttributes.getIgpTerminationPointAttributes().
      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 TerminationPointEvent.getNodeRef().
      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 TerminationPointEvent.getTopologyRef().
      Returns:
      current value

    • getTpId

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

    • getTpRef

      public Set<org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId> getTpRef()
      Return current value associated with the property corresponding to TpAttributes.getTpRef().
      Returns:
      current value

    • augmentation

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

    • setIgpTerminationPointAttributes

      public TerminationPointEventBuilder setIgpTerminationPointAttributes(IgpTerminationPointAttributes value)
      Set the property corresponding to IgpTerminationPointAttributes.getIgpTerminationPointAttributes() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setL3UnicastIgpTopology

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

    • setNodeRef

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

    • setTopologyRef

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

    • setTpId

      public TerminationPointEventBuilder setTpId(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId value)
      Set the property corresponding to TpAttributes.getTpId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTpRef

      public TerminationPointEventBuilder setTpRef(Set<org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TpId> values)
      Set the property corresponding to TpAttributes.getTpRef() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • addAugmentation

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