Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.linkstate.object.type.link._case

Class LocalNodeDescriptorsBuilder

  • @Generated("mdsal-binding-generator")
public class LocalNodeDescriptorsBuilder
extends Object
    Class that builds LocalNodeDescriptors 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: 

       
     LocalNodeDescriptors createLocalNodeDescriptors(int fooXyzzy, int barBaz) {
         return new LocalNodeDescriptorsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • LocalNodeDescriptorsBuilder

        public LocalNodeDescriptorsBuilder()
        Construct an empty builder.

      • LocalNodeDescriptorsBuilder

        public LocalNodeDescriptorsBuilder​(NodeIdentifier arg)
        Construct a new builder initialized from specified NodeIdentifier.
        Parameters:
        arg - NodeIdentifier from which the builder should be initialized

      • LocalNodeDescriptorsBuilder

        public LocalNodeDescriptorsBuilder​(EpeNodeDescriptors arg)
        Construct a new builder initialized from specified EpeNodeDescriptors.
        Parameters:
        arg - EpeNodeDescriptors from which the builder should be initialized

      • LocalNodeDescriptorsBuilder

        public LocalNodeDescriptorsBuilder​(LocalNodeDescriptors base)
        Construct a builder initialized with state from specified LocalNodeDescriptors.
        Parameters:
        base - LocalNodeDescriptors from which the builder should be initialized

    • 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:
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

      • getAsNumber

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getAsNumber()
        Return current value associated with the property corresponding to NodeIdentifier.getAsNumber().
        Returns:
        current value

      • getBgpRouterId

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getBgpRouterId()
        Return current value associated with the property corresponding to EpeNodeDescriptors.getBgpRouterId().
        Returns:
        current value

      • getMemberAsn

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getMemberAsn()
        Return current value associated with the property corresponding to EpeNodeDescriptors.getMemberAsn().
        Returns:
        current value

      • augmentation

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

      • setAsNumber

        public LocalNodeDescriptorsBuilder setAsNumber​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
        Set the property corresponding to NodeIdentifier.getAsNumber() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setBgpRouterId

        public LocalNodeDescriptorsBuilder setBgpRouterId​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
        Set the property corresponding to EpeNodeDescriptors.getBgpRouterId() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setMemberAsn

        public LocalNodeDescriptorsBuilder setMemberAsn​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber value)
        Set the property corresponding to EpeNodeDescriptors.getMemberAsn() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • addAugmentation

        public LocalNodeDescriptorsBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<LocalNodeDescriptors> 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 LocalNodeDescriptorsBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LocalNodeDescriptors>> 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