Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.server.rev220321.pcc.configured.lsp.configured.lsp.intended.path

Class ConstraintsBuilder

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

       
     Constraints createConstraints(int fooXyzzy, int barBaz) {
         return new ConstraintsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • ConstraintsBuilder

        public ConstraintsBuilder()
        Construct an empty builder.

      • ConstraintsBuilder

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

      • ConstraintsBuilder

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

      • getAdminGroup

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

      • getClassType

        public org.opendaylight.yangtools.yang.common.Uint8 getClassType()
        Return current value associated with the property corresponding to PathConstraints.getClassType().
        Returns:
        current value

      • getLoss

        public Loss getLoss()
        Return current value associated with the property corresponding to PathConstraints.getLoss().
        Returns:
        current value

      • getMetric

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

      • getTeMetric

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

      • augmentation

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

      • setAdminGroup

        public ConstraintsBuilder setAdminGroup​(org.opendaylight.yangtools.yang.common.Uint32 value)
        Set the property corresponding to PathConstraints.getAdminGroup() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setClassType

        public ConstraintsBuilder setClassType​(org.opendaylight.yangtools.yang.common.Uint8 value)
        Set the property corresponding to PathConstraints.getClassType() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setMetric

        public ConstraintsBuilder setMetric​(org.opendaylight.yangtools.yang.common.Uint32 value)
        Set the property corresponding to PathConstraints.getMetric() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • setTeMetric

        public ConstraintsBuilder setTeMetric​(org.opendaylight.yangtools.yang.common.Uint32 value)
        Set the property corresponding to PathConstraints.getTeMetric() to the specified value.
        Parameters:
        value - desired value
        Returns:
        this builder

      • addAugmentation

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