Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.pcep.session.state

Class PeerPrefBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.pcep.session.state.PeerPrefBuilder
@Generated("mdsal-binding-generator") public class PeerPrefBuilder extends Object
Class that builds PeerPref 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: 

   
     PeerPref createPeerPref(int fooXyzzy, int barBaz) {
         return new PeerPrefBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • PeerPrefBuilder

      public PeerPrefBuilder()
      Construct an empty builder.

    • PeerPrefBuilder

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

    • PeerPrefBuilder

      public PeerPrefBuilder(PeerPref base)
      Construct a builder initialized with state from specified PeerPref.
      Parameters:
      base - PeerPref 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

    • empty

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

    • getDeadtimer

      public org.opendaylight.yangtools.yang.common.Uint8 getDeadtimer()
      Return current value associated with the property corresponding to Preferences.getDeadtimer().
      Returns:
      current value

    • getIpAddress

      public String getIpAddress()
      Return current value associated with the property corresponding to Preferences.getIpAddress().
      Returns:
      current value

    • getKeepalive

      public org.opendaylight.yangtools.yang.common.Uint8 getKeepalive()
      Return current value associated with the property corresponding to Preferences.getKeepalive().
      Returns:
      current value

    • getSessionId

      public org.opendaylight.yangtools.yang.common.Uint16 getSessionId()
      Return current value associated with the property corresponding to Preferences.getSessionId().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerPref>> 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

    • setDeadtimer

      public PeerPrefBuilder setDeadtimer(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to Preferences.getDeadtimer() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setIpAddress

      public PeerPrefBuilder setIpAddress(String value)
      Set the property corresponding to Preferences.getIpAddress() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setKeepalive

      public PeerPrefBuilder setKeepalive(org.opendaylight.yangtools.yang.common.Uint8 value)
      Set the property corresponding to Preferences.getKeepalive() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSessionId

      public PeerPrefBuilder setSessionId(org.opendaylight.yangtools.yang.common.Uint16 value)
      Set the property corresponding to Preferences.getSessionId() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

      public PeerPrefBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PeerPref> 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 PeerPrefBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerPref>> 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 PeerPref build()
      A new PeerPref instance.
      Returns:
      A new PeerPref instance.