Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pce.id.object

Class PceIdBuilder

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

       
     PceId createPceId(int fooXyzzy, int barBaz) {
         return new PceIdBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • PceIdBuilder

        public PceIdBuilder()
        Construct an empty builder.

      • PceIdBuilder

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

      • PceIdBuilder

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

      • PceIdBuilder

        public PceIdBuilder​(PceId base)
        Construct a builder initialized with state from specified PceId.
        Parameters:
        base - PceId 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

      • getIgnore

        public Boolean getIgnore()
        Return current value associated with the property corresponding to ObjectHeader.getIgnore().
        Returns:
        current value

      • getIpAddress

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

      • augmentation

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

      • setIpAddress

        public PceIdBuilder setIpAddress​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone value)
        Set the property corresponding to PceId.getIpAddress() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • addAugmentation

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