public class OptionsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Options>
OptionsBuilder
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:
OptionsBuilder createTarget(int fooXyzzy, int barBaz) {
return new OptionsBuilderBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of OptionsBuilder, as instances can be freely passed around without worrying about synchronization issues.
As a side note: method chaining results in:
build()
, which is then returned from the methodOptionsBuilder
,
Builder
Constructor and Description |
---|
OptionsBuilder() |
OptionsBuilder(Options base) |
Modifier and Type | Method and Description |
---|---|
OptionsBuilder |
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Options>> augmentationType,
org.opendaylight.yangtools.yang.binding.Augmentation<Options> augmentationValue) |
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Options>> |
augmentation(Class<E$$> augmentationType) |
Options |
build() |
String |
getOption() |
String |
getValue() |
OptionsKey |
key() |
OptionsBuilder |
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Options>> augmentationType) |
OptionsBuilder |
setOption(String value) |
OptionsBuilder |
setValue(String value) |
OptionsBuilder |
withKey(OptionsKey key) |
public OptionsBuilder()
public OptionsBuilder(Options base)
public OptionsKey key()
public String getOption()
public String getValue()
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Options>> E$$ augmentation(Class<E$$> augmentationType)
public OptionsBuilder withKey(OptionsKey key)
public OptionsBuilder setOption(String value)
public OptionsBuilder setValue(String value)
public OptionsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Options>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Options> augmentationValue)
public OptionsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Options>> augmentationType)
public Options build()
build
in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Options,IllegalArgumentException>
Copyright © 2019 OpenDaylight. All rights reserved.