org.opencode4workspace.builders

Class InputDataSenderBuilder

java.lang.Object

org.opencode4workspace.builders.InputDataSenderBuilder

All Implemented Interfaces:

Serializable, IDataSenderBuilder

public class InputDataSenderBuilder
extends Object
implements Serializable, IDataSenderBuilder

Since:

0.6.0 DataSenderBuilder for sending GraphQL mutation content. The object will have a name and fields to pass. Consult WWS Graph QL Builder for details of what attributes etc at https://workspace.ibm.com/graphql

Author:

Paul Withers

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InputDataSenderBuilder() Raw constructor.
InputDataSenderBuilder(String mutationName) Base constructor, defining the mutation name

Method Summary

Modifier and Type	Method and Description
InputDataSenderBuilder	addChild(IDataSenderBuilder child) Add a request for a specific child from the object
InputDataSenderBuilder	addField(String key, Object value) Adds a field and its value to set via the mutation
InputDataSenderBuilder	addField(WWFieldsAttributesInterface enumName, Object value) Adds a field and its value to set via the mutation
String	build() Builds the JSON stream to send.
String	build(boolean pretty) Builds the JSON stream to send, optionally adding pretty styling
List<IDataSenderBuilder>	getChildren()
Map<String,Object>	getFieldsMap()
String	getMutationName()
InputDataSenderBuilder	removeChild(IDataSenderBuilder child) Removes a request for a specific child from the object
InputDataSenderBuilder	removeField(String key) Removes a field to set via the mutation
InputDataSenderBuilder	removeField(WWFieldsAttributesInterface enumName) Removes a field to set via the mutation
InputDataSenderBuilder	setChildren(List<IDataSenderBuilder> children)
void	setFieldsMap(Map<String,Object> fieldsMap)
void	setMutationName(String mutationName)

Methods inherited from class java.lang.Object

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

Constructor Detail

InputDataSenderBuilder

public InputDataSenderBuilder()

Raw constructor. Recommendation is to use overloaded methods

InputDataSenderBuilder

public InputDataSenderBuilder(String mutationName)

Base constructor, defining the mutation name

Parameters:

mutationName - String name of the mutation, e.g. createSpace

Method Detail

build

public String build()

Description copied from interface: IDataSenderBuilder

Builds the JSON stream to send. Calls IDataSenderBuilder.build(boolean), passing false

Specified by:

build in interface IDataSenderBuilder

Returns:

String, JSON data

build

public String build(boolean pretty)

Description copied from interface: IDataSenderBuilder

Builds the JSON stream to send, optionally adding pretty styling

Specified by:

build in interface IDataSenderBuilder

Parameters:

pretty - boolean whether or not to output in a more readable format

Returns:

String, JSON data

getMutationName

public String getMutationName()

Returns:

String, name of the mutation object

Since:

0.6.0

setMutationName

public void setMutationName(String mutationName)

Parameters:

mutationName - String, name of the mutation object

Since:

0.6.0

getFieldsMap

public Map<String,Object> getFieldsMap()

Returns:

Map of fields and values to set via the mutation

Since:

0.6.0

setFieldsMap

public void setFieldsMap(Map<String,Object> fieldsMap)

Parameters:

fieldsMap - Map of fields to set via the mutation

Since:

0.6.0

addField

public InputDataSenderBuilder addField(String key,
                                       Object value)

Adds a field and its value to set via the mutation

Parameters:

key - String field name

value - Object value to set

Returns:

InputDataSender, current object

Since:

0.6.0

addField

public InputDataSenderBuilder addField(WWFieldsAttributesInterface enumName,
                                       Object value)
                                throws WWException

Adds a field and its value to set via the mutation

Parameters:

enumName - WWFieldsAttributesInterface enum, whose label property is the name of the field to set via the mutation

value - Object value to set

Returns:

InputDataSender, current object

Throws:

WWException - containing an error message, if the value is a different data type to what the enum expects

Since:

0.6.0

removeField

public InputDataSenderBuilder removeField(String key)

Removes a field to set via the mutation

Parameters:

key - String field name

Returns:

InputDataSender, current object

Since:

0.6.0

removeField

public InputDataSenderBuilder removeField(WWFieldsAttributesInterface enumName)

Removes a field to set via the mutation

Parameters:

enumName - WWFieldsAttributesInterface enum, whose label property is the name of the field to set via the mutation

Returns:

InputDataSender, current object

Since:

0.6.0

getChildren

public List<IDataSenderBuilder> getChildren()

Returns:

List of IDataSenderBuilder children to request from the object

Since:

0.8.0

setChildren

public InputDataSenderBuilder setChildren(List<IDataSenderBuilder> children)

Parameters:

children - List of IDataSenderBuilder children to request from the object

Returns:

InputDataSenderBuilder, current object

Since:

0.8.0

addChild

public InputDataSenderBuilder addChild(IDataSenderBuilder child)

Add a request for a specific child from the object

Parameters:

child - DataSenderBuilder, child to add

Returns:

InputDataSenderBuilder, current object

Since:

0.8.0

removeChild

public InputDataSenderBuilder removeChild(IDataSenderBuilder child)

Removes a request for a specific child from the object

Parameters:

child - DataSenderBuilder, child to remove

Returns:

ObjectDataSenderBuilder, current object

Since:

0.8.0