Package org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.ospf.node.attributes.ospf.node.attributes

Class TedBuilder

java.lang.Object
org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.ospf.node.attributes.ospf.node.attributes.TedBuilder
@Generated("mdsal-binding-generator") public class TedBuilder extends Object
Class that builds Ted 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: 

   
     Ted createTed(int fooXyzzy, int barBaz) {
         return new TedBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • TedBuilder

      public TedBuilder()
      Construct an empty builder.

    • TedBuilder

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

    • TedBuilder

      public TedBuilder(Ted base)
      Construct a builder initialized with state from specified Ted.
      Parameters:
      base - Ted 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 Ted empty()
      Get empty instance of Ted.
      Returns:
      An empty Ted

    • getIpv4LocalAddress

      public Map<Ipv4LocalAddressKey,Ipv4LocalAddress> getIpv4LocalAddress()
      Return current value associated with the property corresponding to TedNodeAttributes.getIpv4LocalAddress().
      Returns:
      current value

    • getIpv6LocalAddress

      public Map<Ipv6LocalAddressKey,Ipv6LocalAddress> getIpv6LocalAddress()
      Return current value associated with the property corresponding to TedNodeAttributes.getIpv6LocalAddress().
      Returns:
      current value

    • getPccCapabilities

      public PccCapabilities getPccCapabilities()
      Return current value associated with the property corresponding to TedNodeAttributes.getPccCapabilities().
      Returns:
      current value

    • getTeRouterIdIpv4

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address getTeRouterIdIpv4()
      Return current value associated with the property corresponding to TedNodeAttributes.getTeRouterIdIpv4().
      Returns:
      current value

    • getTeRouterIdIpv6

      public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address getTeRouterIdIpv6()
      Return current value associated with the property corresponding to TedNodeAttributes.getTeRouterIdIpv6().
      Returns:
      current value

    • augmentation

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

    • setIpv4LocalAddress

      public TedBuilder setIpv4LocalAddress(Map<Ipv4LocalAddressKey,Ipv4LocalAddress> values)
      Set the property corresponding to TedNodeAttributes.getIpv4LocalAddress() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setIpv6LocalAddress

      public TedBuilder setIpv6LocalAddress(Map<Ipv6LocalAddressKey,Ipv6LocalAddress> values)
      Set the property corresponding to TedNodeAttributes.getIpv6LocalAddress() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setPccCapabilities

      public TedBuilder setPccCapabilities(PccCapabilities value)
      Set the property corresponding to TedNodeAttributes.getPccCapabilities() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTeRouterIdIpv4

      public TedBuilder setTeRouterIdIpv4(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address value)
      Set the property corresponding to TedNodeAttributes.getTeRouterIdIpv4() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setTeRouterIdIpv6

      public TedBuilder setTeRouterIdIpv6(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Address value)
      Set the property corresponding to TedNodeAttributes.getTeRouterIdIpv6() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • addAugmentation

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