Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.ietf.stateful.rev200720.path.binding.tlv.path.binding.binding.type.value

Class Srv6Builder

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

       
     Srv6 createSrv6(int fooXyzzy, int barBaz) {
         return new Srv6Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • Srv6Builder

        public Srv6Builder()
        Construct an empty builder.

      • Srv6Builder

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

    • Method Detail

      • getSrv6Address

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

      • augmentation

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

      • setSrv6Address

        public Srv6Builder setSrv6Address​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone value)
        Set the property corresponding to Srv6.getSrv6Address() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • addAugmentation

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