Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.path.computation.rev220324.path.descriptions

Class PathDescriptionBuilder

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

       
     PathDescription createPathDescription(int fooXyzzy, int barBaz) {
         return new PathDescriptionBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • PathDescriptionBuilder

        public PathDescriptionBuilder()
        Construct an empty builder.

      • PathDescriptionBuilder

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

    • Method Detail

      • getIpv4

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

      • getIpv6

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

      • getRemoteIpv4

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

      • getRemoteIpv6

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

      • getSid

        public org.opendaylight.yangtools.yang.common.Uint32 getSid()
        Return current value associated with the property corresponding to PathDescription.getSid().
        Returns:
        current value

      • augmentation

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

      • setIpv4

        public PathDescriptionBuilder setIpv4​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)
        Set the property corresponding to PathDescription.getIpv4() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setIpv6

        public PathDescriptionBuilder setIpv6​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value)
        Set the property corresponding to PathDescription.getIpv6() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setRemoteIpv4

        public PathDescriptionBuilder setRemoteIpv4​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)
        Set the property corresponding to PathDescription.getRemoteIpv4() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setRemoteIpv6

        public PathDescriptionBuilder setRemoteIpv6​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value)
        Set the property corresponding to PathDescription.getRemoteIpv6() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setSid

        public PathDescriptionBuilder setSid​(org.opendaylight.yangtools.yang.common.Uint32 value)
        Set the property corresponding to PathDescription.getSid() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • addAugmentation

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