BMWorldSetup.BMWorldSetupBuilder (org.spectrumauctions:sats 0.7.0 API)

java.lang.Object
- org.spectrumauctions.sats.core.model.bvm.BMWorldSetup.BMWorldSetupBuilder

Direct Known Subclasses:

BVMWorldSetup.BVMWorldSetupBuilder, MBVMWorldSetup.MBVMWorldSetupBuilder

Enclosing class:

BMWorldSetup
```
public abstract static class BMWorldSetup.BMWorldSetupBuilder
extends java.lang.Object
```

Field Summary

Fields
Modifier and Type Field Description

protected java.util.Map<java.lang.String,java.lang.Integer> bands

protected java.lang.String setupName

Constructor Summary

Constructors
Constructor Description

BMWorldSetupBuilder(java.lang.String setupName)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addBand(java.lang.String nameOfBand, int numberOfLicenses)`	Define new Band which should be generated in the model
`abstract BMWorldSetup`	`build()`
`java.util.Map<java.lang.String,java.lang.Integer>`	`getBands()`	See `BMWorldSetup.bands()` for the purpose of this parameter
`java.lang.String`	`getSetupName()`	See `BMWorldSetup.getSetupName()` for the purpose of this parameter
`boolean`	`removeBand(java.lang.String nameOfBand)`	Remove a band, such that it will not be created.
`void`	`setSetupName(java.lang.String setupName)`	See `BMWorldSetup.getSetupName()` for the purpose of this parameter

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - setupName
```
protected java.lang.String setupName
```
  - bands
```
protected java.util.Map<java.lang.String,java.lang.Integer> bands
```
- Constructor Detail
  - BMWorldSetupBuilder
```
public BMWorldSetupBuilder(java.lang.String setupName)
```
- Method Detail
  - addBand
```
public void addBand(java.lang.String nameOfBand,
                    int numberOfLicenses)
```
    Define new Band which should be generated in the model
  - removeBand
```
public boolean removeBand(java.lang.String nameOfBand)
```
    Remove a band, such that it will not be created.
    
    Parameters:
    
    nameOfBand - the name of the band
    
    Returns:
    
    true, if band was removed. false otherwise
  - getBands
```
public java.util.Map<java.lang.String,java.lang.Integer> getBands()
```
    See BMWorldSetup.bands() for the purpose of this parameter
  - getSetupName
```
public java.lang.String getSetupName()
```
    See BMWorldSetup.getSetupName() for the purpose of this parameter
  - setSetupName
```
public void setSetupName(java.lang.String setupName)
```
    See BMWorldSetup.getSetupName() for the purpose of this parameter
  - build
```
public abstract BMWorldSetup build()
```
    Returns:
    
    An immutable BMWorldSetup Instance with the in this builder instance defined parameters.