org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.port.mod

Class PortBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.port.mod.PortBuilder

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Builder<Port>, org.opendaylight.yangtools.concepts.CheckedBuilder<Port,IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

public class PortBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Port>

Class that builds PortBuilder 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:

   
     PortBuilder createTarget(int fooXyzzy, int barBaz) {
         return new PortBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

PortBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
PortBuilder()
PortBuilder(Port base)

Method Summary

Modifier and Type	Method and Description
PortBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Port>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Port> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Port>> E$$	augmentation(Class<E$$> augmentationType)
Port	build()
List<Port>	getPort()
PortBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Port>> augmentationType)
PortBuilder	setPort(List<Port> values)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PortBuilder

public PortBuilder()

PortBuilder

public PortBuilder(Port base)

Method Detail

getPort

public List<Port> getPort()

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Port>> E$$ augmentation(Class<E$$> augmentationType)

setPort

public PortBuilder setPort(List<Port> values)

addAugmentation

public PortBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Port>> augmentationType,
                                   org.opendaylight.yangtools.yang.binding.Augmentation<Port> augmentationValue)

removeAugmentation

public PortBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Port>> augmentationType)

build

public Port build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Port,IllegalArgumentException>