Class IgpLinkEventBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<IgpLinkEvent>, org.opendaylight.yangtools.concepts.CheckedBuilder<IgpLinkEvent,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

    @Generated("mdsal-binding-generator")
    public class IgpLinkEventBuilder
    extends Object
    implements org.opendaylight.yangtools.concepts.Builder<IgpLinkEvent>
    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:
    IgpLinkEvent, Builder
    • Constructor Detail

      • IgpLinkEventBuilder

        public IgpLinkEventBuilder()
      • IgpLinkEventBuilder

        public IgpLinkEventBuilder​(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkAttributes arg)
      • IgpLinkEventBuilder

        public IgpLinkEventBuilder​(IgpLinkEvent base)
    • Method Detail

      • 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:
        • org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.IgpLinkAttributes
        • LinkAttributes
        • L3UnicastIgpTopologyType
        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()
      • getLinkId

        public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId getLinkId()
      • getSource

        public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.link.attributes.Source getSource()
      • 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()
      • getTopologyRef

        public org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId getTopologyRef()
      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpLinkEvent>> E$$ augmentation​(Class<E$$> augmentationType)
      • setDestination

        public IgpLinkEventBuilder setDestination​(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.link.attributes.Destination value)
      • setLinkId

        public IgpLinkEventBuilder setLinkId​(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.LinkId value)
      • setSource

        public IgpLinkEventBuilder setSource​(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.link.attributes.Source value)
      • 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)
      • setTopologyRef

        public IgpLinkEventBuilder setTopologyRef​(org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.topology.rev131021.TopologyId value)
      • 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