Class ConstraintsBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Constraints>, org.opendaylight.yangtools.concepts.CheckedBuilder<Constraints,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

    public class ConstraintsBuilder
    extends Object
    implements org.opendaylight.yangtools.concepts.Builder<Constraints>
    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())

    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, Builder
    • Constructor Detail

      • ConstraintsBuilder

        public ConstraintsBuilder()
      • ConstraintsBuilder

        public ConstraintsBuilder​(Constraints base)
    • 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:
        • PathConstraints
        arg - grouping object
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • getAdminGroup

        public org.opendaylight.yangtools.yang.common.Uint32 getAdminGroup()
      • getClassType

        public org.opendaylight.yangtools.yang.common.Uint8 getClassType()
      • getDelay

        public Delay getDelay()
      • getJitter

        public Delay getJitter()
      • getLoss

        public Loss getLoss()
      • getMetric

        public org.opendaylight.yangtools.yang.common.Uint32 getMetric()
      • getTeMetric

        public org.opendaylight.yangtools.yang.common.Uint32 getTeMetric()
      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Constraints>> E$$ augmentation​(Class<E$$> augmentationType)
      • setAdminGroup

        public ConstraintsBuilder setAdminGroup​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setClassType

        public ConstraintsBuilder setClassType​(org.opendaylight.yangtools.yang.common.Uint8 value)
      • setMetric

        public ConstraintsBuilder setMetric​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setTeMetric

        public ConstraintsBuilder setTeMetric​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • addAugmentation

        public ConstraintsBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<Constraints> augmentation)
        Add an augmentation to this builder's product.
        augmentation - augmentation to be added
        this builder
        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.
        augmentationType - augmentation type to be removed
        this builder