Class MldpMp2mpLspBuilder

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

    public class MldpMp2mpLspBuilder
    extends Object
    implements org.opendaylight.yangtools.concepts.Builder<MldpMp2mpLsp>
    Class that builds MldpMp2mpLsp 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:

         MldpMp2mpLsp createMldpMp2mpLsp(int fooXyzzy, int barBaz) {
             return new MldpMp2mpLspBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

    This pattern is supported by the immutable nature of MldpMp2mpLsp, 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:
    MldpMp2mpLsp, Builder
    • Constructor Detail

      • MldpMp2mpLspBuilder

        public MldpMp2mpLspBuilder()
      • MldpMp2mpLspBuilder

        public MldpMp2mpLspBuilder​(Opaque arg)
      • MldpMp2mpLspBuilder

        public MldpMp2mpLspBuilder​(MldpMp2mpLsp 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:
        • Opaque
        arg - grouping object
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • getOpaque

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.HexString getOpaque()
      • getOpaqueExtendedType

        public org.opendaylight.yangtools.yang.common.Uint16 getOpaqueExtendedType()
      • getOpaqueType

        public org.opendaylight.yangtools.yang.common.Uint8 getOpaqueType()
      • augmentation

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

        public MldpMp2mpLspBuilder setOpaque​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.HexString value)
      • setOpaqueExtendedType

        public MldpMp2mpLspBuilder setOpaqueExtendedType​(org.opendaylight.yangtools.yang.common.Uint16 value)
      • setOpaqueType

        public MldpMp2mpLspBuilder setOpaqueType​(org.opendaylight.yangtools.yang.common.Uint8 value)
      • addAugmentation

        public MldpMp2mpLspBuilder addAugmentation​(org.opendaylight.yangtools.yang.binding.Augmentation<MldpMp2mpLsp> augmentation)
        Add an augmentation to this builder's product.
        augmentation - augmentation to be added
        this builder
        NullPointerException - if augmentation is null
      • removeAugmentation

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