Class EndpointBuilder

  • @Generated("mdsal-binding-generator")
    public class EndpointBuilder
    extends Object
    Class that builds Endpoint 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:

         Endpoint createEndpoint(int fooXyzzy, int barBaz) {
             return new EndpointBuilder()
                 .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
                 .setBar(new BarBuilder().setBaz(barBaz).build())

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

      • EndpointBuilder

        public EndpointBuilder()
        Construct an empty builder.
      • EndpointBuilder

        public EndpointBuilder​(Endpoint base)
        Construct a builder initialized with state from specified Endpoint.
        base - Endpoint from which the builder should be initialized
    • Method Detail

      • key

        public EndpointKey key()
        Return current value associated with the property corresponding to Endpoint.key().
        current value
      • getConfig

        public Config getConfig()
        Return current value associated with the property corresponding to Endpoint.getConfig().
        current value
      • getEndpointId

        public String getEndpointId()
        Return current value associated with the property corresponding to Endpoint.getEndpointId().
        current value
      • getState

        public State getState()
        Return current value associated with the property corresponding to Endpoint.getState().
        current value
      • augmentation

        public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Endpoint>> E$$ augmentation​(Class<E$$> augmentationType)
        Return the specified augmentation, if it is present in this builder.
        Type Parameters:
        E$$ - augmentation type
        augmentationType - augmentation type class
        Augmentation object from this builder, or null if not present
        NullPointerException - if augmentType is null
      • setState

        public EndpointBuilder setState​(State value)
        Set the property corresponding to Endpoint.getState() to the specified value.
        value - desired value
        this builder
      • addAugmentation

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

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