Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.interfaces.top.interfaces

Class InterfaceBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.interfaces.top.interfaces.InterfaceBuilder
@Generated("mdsal-binding-generator") public class InterfaceBuilder extends Object
Class that builds Interface 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: 

   
     Interface createInterface(int fooXyzzy, int barBaz) {
         return new InterfaceBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • InterfaceBuilder

      public InterfaceBuilder()
      Construct an empty builder.

    • InterfaceBuilder

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

    • InterfaceBuilder

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

    • InterfaceBuilder

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

    • key

      public InterfaceKey key()
      Return current value associated with the property corresponding to Interface.key().
      Returns:
      current value

    • getConfig

      public Config getConfig()
      Return current value associated with the property corresponding to Interface.getConfig().
      Returns:
      current value

    • getHoldTime

      public HoldTime getHoldTime()
      Return current value associated with the property corresponding to InterfacePhysHoldtimeTop.getHoldTime().
      Returns:
      current value

    • getName

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

    • getState

      public State getState()
      Return current value associated with the property corresponding to Interface.getState().
      Returns:
      current value

    • getSubinterfaces

      public Subinterfaces getSubinterfaces()
      Return current value associated with the property corresponding to SubinterfacesTop.getSubinterfaces().
      Returns:
      current value

    • augmentation

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

    • withKey

      public InterfaceBuilder withKey(InterfaceKey key)
      Set the key value corresponding to Interface.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setConfig

      public InterfaceBuilder setConfig(Config value)
      Set the property corresponding to Interface.getConfig() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setHoldTime

      public InterfaceBuilder setHoldTime(HoldTime value)
      Set the property corresponding to InterfacePhysHoldtimeTop.getHoldTime() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setName

      public InterfaceBuilder setName(String value)
      Set the property corresponding to Interface.getName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setState

      public InterfaceBuilder setState(State value)
      Set the property corresponding to Interface.getState() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setSubinterfaces

      public InterfaceBuilder setSubinterfaces(Subinterfaces value)
      Set the property corresponding to SubinterfacesTop.getSubinterfaces() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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