Class PduOpenTlvBuilder

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

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

         PduOpenTlv createPduOpenTlv(int fooXyzzy, int barBaz) {
             return new PduOpenTlvBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

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

      • PduOpenTlvBuilder

        public PduOpenTlvBuilder()
      • PduOpenTlvBuilder

        public PduOpenTlvBuilder​(Tlv arg)
      • PduOpenTlvBuilder

        public PduOpenTlvBuilder​(OpenMessage arg)
      • PduOpenTlvBuilder

        public PduOpenTlvBuilder​(PduOpenTlv 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:
        • OpenMessage
        • Tlv
        arg - grouping object
        IllegalArgumentException - if given argument is none of valid types or has property with incompatible value
      • getBgpIdentifier

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getBgpIdentifier()
      • getHoldTimer

        public org.opendaylight.yangtools.yang.common.Uint16 getHoldTimer()
      • getMyAsNumber

        public org.opendaylight.yangtools.yang.common.Uint16 getMyAsNumber()
      • augmentation

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

        public PduOpenTlvBuilder setBgpIdentifier​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
      • setHoldTimer

        public PduOpenTlvBuilder setHoldTimer​(org.opendaylight.yangtools.yang.common.Uint16 value)
      • setMyAsNumber

        public PduOpenTlvBuilder setMyAsNumber​(org.opendaylight.yangtools.yang.common.Uint16 value)
      • addAugmentation

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

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