Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.md.sal.clustering.prefix.shard.configuration.rev170110.prefix.shards

Class ShardBuilder

  • All Implemented Interfaces:
    org.opendaylight.yangtools.concepts.Builder<Shard>, org.opendaylight.yangtools.concepts.CheckedBuilder<Shard,​IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
    public class ShardBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Shard>
    Class that builds ShardBuilder 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: 

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

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

    • Constructor Detail

      • ShardBuilder

        public ShardBuilder()

      • ShardBuilder

        public ShardBuilder​(Shard base)

    • Method Detail

      • getPrefix

        public org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> getPrefix()

      • getReplicas

        public Replicas getReplicas()

      • augmentation

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

      • setPrefix

        public ShardBuilder setPrefix​(org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> value)

      • addAugmentation

        public ShardBuilder addAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Shard>> augmentationType,
                                    org.opendaylight.yangtools.yang.binding.Augmentation<Shard> augmentationValue)

      • removeAugmentation

        public ShardBuilder removeAugmentation​(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Shard>> augmentationType)

      • build

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