Class PrefixBuilder

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

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

       
         PrefixBuilder createTarget(int fooXyzzy, int barBaz) {
             return new PrefixBuilderBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())
                 .build();
         }
       
     

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

      • PrefixBuilder

        public PrefixBuilder()
      • PrefixBuilder

        public PrefixBuilder​(Prefix arg)
      • PrefixBuilder

        public PrefixBuilder​(Prefix 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:
        • org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev191125.Prefix
        Parameters:
        arg - grouping object
        Throws:
        IllegalArgumentException - if given argument is none of valid types
      • getPrefix

        public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getPrefix()
      • getPrefixSid

        public org.opendaylight.yangtools.yang.common.Uint32 getPrefixSid()
      • getVertexId

        public org.opendaylight.yangtools.yang.common.Uint64 getVertexId()
      • isNodeSid

        public Boolean isNodeSid()
      • augmentation

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

        public PrefixBuilder setPrefix​(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
      • setPrefixSid

        public PrefixBuilder setPrefixSid​(org.opendaylight.yangtools.yang.common.Uint32 value)
      • setPrefixSid

        @Deprecated(forRemoval=true)
        public PrefixBuilder setPrefixSid​(Long value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setPrefixSid(Uint32)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder
      • setVertexId

        public PrefixBuilder setVertexId​(org.opendaylight.yangtools.yang.common.Uint64 value)
      • setVertexId

        @Deprecated(forRemoval=true)
        public PrefixBuilder setVertexId​(BigInteger value)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Use {#link setVertexId(Uint64)} instead.
        Utility migration setter.
        Parameters:
        value - field value in legacy type
        Returns:
        this builder
      • addAugmentation

        public PrefixBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Prefix>> augmentationType,
                                             org.opendaylight.yangtools.yang.binding.Augmentation<Prefix> augmentationValue)
      • removeAugmentation

        public PrefixBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Prefix>> augmentationType)
      • build

        public Prefix build()
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.Builder<Prefix>
        Specified by:
        build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Prefix,​IllegalArgumentException>