Package org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.igp.node.attributes

Class IgpNodeAttributesBuilder

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

   
     IgpNodeAttributes createIgpNodeAttributes(int fooXyzzy, int barBaz) {
         return new IgpNodeAttributesBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }

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

    • IgpNodeAttributesBuilder

      public IgpNodeAttributesBuilder()
      Construct an empty builder.

    • IgpNodeAttributesBuilder

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

  • Method Details

    • empty

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

    • getFlag

      public Set<FlagIdentity> getFlag()
      Return current value associated with the property corresponding to IgpNodeAttributes.getFlag().
      Returns:
      current value

    • getName

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

    • getPrefix

      public Map<PrefixKey,Prefix> getPrefix()
      Return current value associated with the property corresponding to IgpNodeAttributes.getPrefix().
      Returns:
      current value

    • getRouterId

      public Set<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress> getRouterId()
      Return current value associated with the property corresponding to IgpNodeAttributes.getRouterId().
      Returns:
      current value

    • augmentation

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

    • setFlag

      public IgpNodeAttributesBuilder setFlag(Set<FlagIdentity> values)
      Set the property corresponding to IgpNodeAttributes.getFlag() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setName

      public IgpNodeAttributesBuilder setName(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.DomainName value)
      Set the property corresponding to IgpNodeAttributes.getName() to the specified value.
      Parameters:
      value - desired value
      Returns:
      this builder

    • setPrefix

      public IgpNodeAttributesBuilder setPrefix(Map<PrefixKey,Prefix> values)
      Set the property corresponding to IgpNodeAttributes.getPrefix() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • setRouterId

      public IgpNodeAttributesBuilder setRouterId(Set<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress> values)
      Set the property corresponding to IgpNodeAttributes.getRouterId() to the specified value.
      Parameters:
      values - desired value
      Returns:
      this builder

    • addAugmentation

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