Class IssuerBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927._switch.certificate.IssuerBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Issuer>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Issuer,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class IssuerBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Issuer>
Class that buildsIssuerBuilder
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:
IssuerBuilder createTarget(int fooXyzzy, int barBaz) { return new IssuerBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IssuerBuilder, 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:
IssuerBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description IssuerBuilder()
IssuerBuilder(Issuer base)
IssuerBuilder(X500Principal arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description IssuerBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Issuer>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Issuer> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.IssuerBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Issuer> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Issuer>>
E$$augmentation(Class<E$$> augmentationType)
Issuer
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.String
getCommonName()
String
getCountry()
String
getLocality()
String
getOrganization()
String
getOrganizationUnit()
String
getState()
IssuerBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Issuer>> augmentationType)
Remove an augmentation from this builder's product.IssuerBuilder
setCommonName(String value)
IssuerBuilder
setCountry(String value)
IssuerBuilder
setLocality(String value)
IssuerBuilder
setOrganization(String value)
IssuerBuilder
setOrganizationUnit(String value)
IssuerBuilder
setState(String value)
-
-
-
Constructor Detail
-
IssuerBuilder
public IssuerBuilder()
-
IssuerBuilder
public IssuerBuilder(X500Principal arg)
-
IssuerBuilder
public IssuerBuilder(Issuer base)
-
-
Method Detail
-
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:- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.X500Principal
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getCommonName
public String getCommonName()
-
getCountry
public String getCountry()
-
getLocality
public String getLocality()
-
getOrganization
public String getOrganization()
-
getOrganizationUnit
public String getOrganizationUnit()
-
getState
public String getState()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Issuer>> E$$ augmentation(Class<E$$> augmentationType)
-
setCommonName
public IssuerBuilder setCommonName(String value)
-
setCountry
public IssuerBuilder setCountry(String value)
-
setLocality
public IssuerBuilder setLocality(String value)
-
setOrganization
public IssuerBuilder setOrganization(String value)
-
setOrganizationUnit
public IssuerBuilder setOrganizationUnit(String value)
-
setState
public IssuerBuilder setState(String value)
-
addAugmentation
public IssuerBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Issuer> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public IssuerBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Issuer>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Issuer> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public IssuerBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Issuer>> 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 Issuer build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Issuer>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Issuer,IllegalArgumentException>
-
-