Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pmsi.tunnel.rev200120.pmsi.tunnel.pmsi.tunnel.tunnel.identifier.mldp.p2mp.lsp.mldp.p2mp.lsp

Class OpaqueValueBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<OpaqueValue>, org.opendaylight.yangtools.concepts.CheckedBuilder<OpaqueValue,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    @Generated("mdsal-binding-generator")
public class OpaqueValueBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<OpaqueValue>
    Class that builds OpaqueValue 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: 

       
     OpaqueValue createOpaqueValue(int fooXyzzy, int barBaz) {
         return new OpaqueValueBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • Constructor Detail

      • OpaqueValueBuilder

        public OpaqueValueBuilder()

      • OpaqueValueBuilder

        public OpaqueValueBuilder​(Opaque arg)

      • OpaqueValueBuilder

        public OpaqueValueBuilder​(OpaqueValue 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
        Parameters:
        arg - grouping object
        Throws:
        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<OpaqueValue>> E$$ augmentation​(Class<E$$> augmentationType)

      • setOpaque

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

      • setOpaqueExtendedType

        public OpaqueValueBuilder setOpaqueExtendedType​(org.opendaylight.yangtools.yang.common.Uint16 value)

      • setOpaqueType

        public OpaqueValueBuilder setOpaqueType​(org.opendaylight.yangtools.yang.common.Uint8 value)

      • addAugmentation

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