Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009

Class State4Builder

java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.State4Builder
@Generated("mdsal-binding-generator") public class State4Builder extends Object
Class that builds State4 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: 

   
     State4 createState4(int fooXyzzy, int barBaz) {
         return new State4Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

This pattern is supported by the immutable nature of State4, 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 Details

    • State4Builder

      public State4Builder()
      Construct an empty builder.

    • State4Builder

      public State4Builder(BgpNeighborErrorHandlingState arg)
      Construct a new builder initialized from specified BgpNeighborErrorHandlingState.
      Parameters:
      arg - BgpNeighborErrorHandlingState from which the builder should be initialized

    • State4Builder

      public State4Builder(State4 base)
      Construct a builder initialized with state from specified State4.
      Parameters:
      base - State4 from which the builder should be initialized

  • Method Details

    • 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:
      Parameters:
      arg - grouping object
      Throws:
      IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

    • getErroneousUpdateMessages

      public org.opendaylight.yangtools.yang.common.Uint32 getErroneousUpdateMessages()
      Return current value associated with the property corresponding to BgpNeighborErrorHandlingState.getErroneousUpdateMessages().
      Returns:
      current value

    • setErroneousUpdateMessages

      public State4Builder setErroneousUpdateMessages(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to BgpNeighborErrorHandlingState.getErroneousUpdateMessages() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • build

      public @NonNull State4 build()
      A new State4 instance.
      Returns:
      A new State4 instance.