Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.policy.rev151009.routing.policy.policy.definitions.policy.definition.statements.statement.actions

Class BgpActionsBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.policy.rev151009.routing.policy.policy.definitions.policy.definition.statements.statement.actions.BgpActionsBuilder
@Generated("mdsal-binding-generator") public class BgpActionsBuilder extends Object
Class that builds BgpActions 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: 

   
     BgpActions createBgpActions(int fooXyzzy, int barBaz) {
         return new BgpActionsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • BgpActionsBuilder

      public BgpActionsBuilder()
      Construct an empty builder.

    • BgpActionsBuilder

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

  • Method Details

    • empty

      public static @NonNull BgpActions empty()
      Get empty instance of BgpActions.
      Returns:
      An empty BgpActions

    • getSetAsPathPrepend

      public SetAsPathPrepend getSetAsPathPrepend()
      Return current value associated with the property corresponding to BgpActions.getSetAsPathPrepend().
      Returns:
      current value

    • getSetCommunity

      public SetCommunity getSetCommunity()
      Return current value associated with the property corresponding to BgpActions.getSetCommunity().
      Returns:
      current value

    • getSetExtCommunity

      public SetExtCommunity getSetExtCommunity()
      Return current value associated with the property corresponding to BgpActions.getSetExtCommunity().
      Returns:
      current value

    • getSetLocalPref

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

    • getSetMed

      public BgpSetMedType getSetMed()
      Return current value associated with the property corresponding to BgpActions.getSetMed().
      Returns:
      current value

    • getSetNextHop

      public BgpNextHopType getSetNextHop()
      Return current value associated with the property corresponding to BgpActions.getSetNextHop().
      Returns:
      current value

    • getSetRouteOrigin

      public BgpOriginAttrType getSetRouteOrigin()
      Return current value associated with the property corresponding to BgpActions.getSetRouteOrigin().
      Returns:
      current value

    • augmentation

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

    • setSetAsPathPrepend

      public BgpActionsBuilder setSetAsPathPrepend(SetAsPathPrepend value)
      Set the property corresponding to BgpActions.getSetAsPathPrepend() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSetCommunity

      public BgpActionsBuilder setSetCommunity(SetCommunity value)
      Set the property corresponding to BgpActions.getSetCommunity() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSetExtCommunity

      public BgpActionsBuilder setSetExtCommunity(SetExtCommunity value)
      Set the property corresponding to BgpActions.getSetExtCommunity() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSetLocalPref

      public BgpActionsBuilder setSetLocalPref(org.opendaylight.yangtools.yang.common.Uint32 value)
      Set the property corresponding to BgpActions.getSetLocalPref() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSetMed

      public BgpActionsBuilder setSetMed(BgpSetMedType value)
      Set the property corresponding to BgpActions.getSetMed() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSetNextHop

      public BgpActionsBuilder setSetNextHop(BgpNextHopType value)
      Set the property corresponding to BgpActions.getSetNextHop() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSetRouteOrigin

      public BgpActionsBuilder setSetRouteOrigin(BgpOriginAttrType value)
      Set the property corresponding to BgpActions.getSetRouteOrigin() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

      public BgpActionsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BgpActions> augmentation)
      Add an augmentation to this builder's product.
      Parameters:
      augmentation - augmentation to be added
      Returns:
      this builder
      Throws:
      NullPointerException - if augmentation is null

    • removeAugmentation

      public BgpActionsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpActions>> augmentationType)
      Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.
      Parameters:
      augmentationType - augmentation type to be removed
      Returns:
      this builder

    • build

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