Package com.almworks.jira.structure.api.attribute

Class AttributeSpecBuilder<T>

Object

AttributeSpecBuilder<T>

Type Parameters:

T -

@PublicApi
public class AttributeSpecBuilder<T>
extends Object

A builder for AttributeSpec.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	AttributeSpecBuilder.ParamsBuilder<P>	Parameter builder class, used to set specific parameters.

Constructor Summary

Constructors

Constructor	Description
AttributeSpecBuilder()

Method Summary

Modifier and Type	Method	Description
AttributeSpec<T>	build()	Builds the attribute spec.
static AttributeSpecBuilder<Void>	create()	Creates an empty builder.
static <T> AttributeSpecBuilder<T>	create(AttributeSpec<T> sample)	Creates a builder based on the given sample.
static AttributeSpecBuilder<Void>	create(String id)	Creates a builder with the given attribute ID.
static <T> AttributeSpecBuilder<T>	create(String id, ValueFormat<T> format)	Creates a builder with the given attribute ID and format.
static <T> AttributeSpecBuilder<T>	create(String id, ValueFormat<T> format, Map<String,Object> params)	Creates a builder with the given attribute ID, format and parameters.
boolean	equals(Object o)
int	hashCode()
AttributeSpecBuilder<T>.ParamsBuilder<AttributeSpecBuilder<T>>	params()	Provides access to AttributeSpecBuilder.ParamsBuilder, which is used to build parameter map.
<R> AttributeSpecBuilder<R>	setFormat(ValueFormat<R> format)	Sets the value format.
AttributeSpecBuilder<T>	setId(String id)	Sets the attribute id.
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AttributeSpecBuilder

public AttributeSpecBuilder()

Method Details

create

@NotNull
public static AttributeSpecBuilder<Void> create()

Creates an empty builder.

Returns:

builder

create

@NotNull
public static AttributeSpecBuilder<Void> create(@Nullable
 String id)

Creates a builder with the given attribute ID.

Parameters:

id - attribute id

Returns:

builder

create

@NotNull
public static <T> AttributeSpecBuilder<T> create(@Nullable
 String id,
 @Nullable
 ValueFormat<T> format)

Creates a builder with the given attribute ID and format.

Parameters:

id - attribute id

format - value format

Returns:

builder

create

@NotNull
public static <T> AttributeSpecBuilder<T> create(@Nullable
 String id,
 @Nullable
 ValueFormat<T> format,
 @Nullable
 Map<String,Object> params)

Creates a builder with the given attribute ID, format and parameters. The parameters are copied from the passed map, so it can be reused by the calling code.

Parameters:

id - attribute id

format - value format

params - parameters map

Returns:

builder

create

public static <T> AttributeSpecBuilder<T> create(AttributeSpec<T> sample)

Creates a builder based on the given sample. Copies all the fields from the attribute spec.

Parameters:

sample - sample attribute spec

Returns:

builder

build

@NotNull
public AttributeSpec<T> build()

Builds the attribute spec.

Returns:

attribute spec

Throws:

IllegalArgumentException - if there's anything wrong with id, format or parameters

setId

public AttributeSpecBuilder<T> setId(String id)

Sets the attribute id.

Parameters:

id - attribute id

Returns:

this builder

setFormat

public <R> AttributeSpecBuilder<R> setFormat(ValueFormat<R> format)

Sets the value format.

Parameters:

format - value format

Returns:

this builder

params

public AttributeSpecBuilder<T>.ParamsBuilder<AttributeSpecBuilder<T>> params()

Provides access to AttributeSpecBuilder.ParamsBuilder, which is used to build parameter map.

Returns:

parameter builder

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object