Module org.mal_lang.langspec

Package org.mal_lang.langspec.builders

Class AttackStepBuilder

java.lang.Object

org.mal_lang.langspec.builders.AttackStepBuilder

public final class AttackStepBuilder
extends Object

A builder for creating AttackStep objects.

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
AttackStepBuilder(String name, AttackStepType type, Risk risk, TtcExpression ttc, StepsBuilder requires, StepsBuilder reaches)	Constructs a new AttackStepBuilder object.

Method Summary

Modifier and Type	Method	Description
AttackStepBuilder	addTag(String tag)	Adds a tag to this AttackStepBuilder object.
static AttackStepBuilder	fromJson(JsonObject jsonAttackStep)	Creates a new AttackStepBuilder from a JsonObject.
MetaBuilder	getMeta()	Returns the meta info of this AttackStepBuilder object.
String	getName()	Returns the name of this AttackStepBuilder object.
StepsBuilder	getReaches()	Returns the reaches steps of this AttackStepBuilder object, or null if no reaches steps has been set.
StepsBuilder	getRequires()	Returns the requires steps of this AttackStepBuilder object, or null if no requires steps have been set.
Risk	getRisk()	Returns the risk of this AttackStepBuilder object, or null if no risk has been set.
List<String>	getTags()	Returns a list of all tags in this AttackStepBuilder object.
TtcExpression	getTtc()	Returns the TTC of this AttackStepBuilder object, or null if no TTC has been set.
AttackStepType	getType()	Returns the type of this AttackStepBuilder object.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttackStepBuilder

public AttackStepBuilder(String name,
                         AttackStepType type,
                         Risk risk,
                         TtcExpression ttc,
                         StepsBuilder requires,
                         StepsBuilder reaches)

Constructs a new AttackStepBuilder object.

Parameters:

name - the name of the attack step

type - the type of the attack step

risk - the risk of the attack step, or null

ttc - the TTC of the attack step, or null

requires - the requires steps of the attack step, or null

reaches - the reaches steps of the attack step, or null

Throws:

NullPointerException - if name or type is null

IllegalArgumentException - if name is not a valid identifier

Since:

1.0.0

Method Detail

getName

public String getName()

Returns the name of this AttackStepBuilder object.

Returns:

the name of this AttackStepBuilder object

Since:

1.0.0

getMeta

public MetaBuilder getMeta()

Returns the meta info of this AttackStepBuilder object.

Returns:

the meta info of this AttackStepBuilder object

Since:

1.0.0

getType

public AttackStepType getType()

Returns the type of this AttackStepBuilder object.

Returns:

the type of this AttackStepBuilder object

Since:

1.0.0

getTags

public List<String> getTags()

Returns a list of all tags in this AttackStepBuilder object.

Returns:

a list of all tags in this AttackStepBuilder object

Since:

1.0.0

addTag

public AttackStepBuilder addTag(String tag)

Adds a tag to this AttackStepBuilder object.

Parameters:

tag - the tag to add

Returns:

this AttackStepBuilder object

Throws:

NullPointerException - if tag is null

IllegalArgumentException - if tag is not a valid identifier

Since:

1.0.0

getRisk

public Risk getRisk()

Returns the risk of this AttackStepBuilder object, or null if no risk has been set.

Returns:

the risk of this AttackStepBuilder object, or null if no risk has been set

Since:

1.0.0

getTtc

public TtcExpression getTtc()

Returns the TTC of this AttackStepBuilder object, or null if no TTC has been set.

Returns:

the TTC of this AttackStepBuilder object, or null if no TTC has been set

Since:

1.0.0

getRequires

public StepsBuilder getRequires()

Returns the requires steps of this AttackStepBuilder object, or null if no requires steps have been set.

Returns:

the requires steps of this AttackStepBuilder object, or null if no requires steps have been set

Since:

1.0.0

getReaches

public StepsBuilder getReaches()

Returns the reaches steps of this AttackStepBuilder object, or null if no reaches steps has been set.

Returns:

the reaches steps of this AttackStepBuilder object, or null if no reaches steps has been set

Since:

1.0.0

fromJson

public static AttackStepBuilder fromJson(JsonObject jsonAttackStep)

Creates a new AttackStepBuilder from a JsonObject.

Parameters:

jsonAttackStep - the JsonObject

Returns:

a new AttackStepBuilder

Throws:

NullPointerException - if jsonAttackStep is null

Since:

1.0.0