Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.protocols

Class ProtocolBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.network.instance.rev151018.network.instance.top.network.instances.network.instance.protocols.ProtocolBuilder
@Generated("mdsal-binding-generator") public class ProtocolBuilder extends Object
Class that builds Protocol 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: 

   
     Protocol createProtocol(int fooXyzzy, int barBaz) {
         return new ProtocolBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • ProtocolBuilder

      public ProtocolBuilder()
      Construct an empty builder.

    • ProtocolBuilder

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

  • Method Details

    • key

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

    • getAggregate

      public Aggregate getAggregate()
      Return current value associated with the property corresponding to Protocol.getAggregate().
      Returns:
      current value

    • getConfig

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

    • getIdentifier

      public InstallProtocolType getIdentifier()
      Return current value associated with the property corresponding to Protocol.getIdentifier().
      Returns:
      current value

    • getName

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

    • getState

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

    • getStatic

      public Static getStatic()
      Return current value associated with the property corresponding to Protocol.getStatic().
      Returns:
      current value

    • augmentation

      public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Protocol>> 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 ProtocolBuilder withKey(ProtocolKey key)
      Set the key value corresponding to Protocol.key() to the specified value.
      Parameters:
      key - desired value
      Returns:
      this builder

    • setAggregate

      public ProtocolBuilder setAggregate(Aggregate value)
      Set the property corresponding to Protocol.getAggregate() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setConfig

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

    • setIdentifier

      public ProtocolBuilder setIdentifier(InstallProtocolType value)
      Set the property corresponding to Protocol.getIdentifier() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setName

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

    • setState

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

    • setStatic

      public ProtocolBuilder setStatic(Static value)
      Set the property corresponding to Protocol.getStatic() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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