com.almworks.jira.structure.api.view

Class ViewSpecification.Column

Object

ViewSpecification.Column

Enclosing class:

ViewSpecification

public static class ViewSpecification.Column
extends Object

Represents a single column configuration in the Structure widget.

Structure columns have the following properties:

• csid - mandatory property that should be an unique column ID within the view specification. Typically, special columns have special csid while all other columns have numeric incrementing csid.
• key - mandatory property that defines the class of the column, its behavior. As of Structure 2.0, there's a predefined set of supported column keys. In the future, we plan to make it expandable.
• name - optional property that defines the header of the column in the grid. If not set, default header is used as decided by the column class.
• parameters - an unbounded map of any parameters that make sense to the specific class of the column.

Supported parameter value types:

• String
• Integer
• Long
• Double
• Boolean
• List with all elements in the list being of supported parameter type
• Map with all keys in the map being Strings and all values of supported parameter type

Class ViewSpecification.Column is immutable and thread-safe. To create or change a column, use ViewSpecification.Column.Builder.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ViewSpecification.Column.Builder ViewSpecification.Column.Builder is used to create instances of ViewSpecification.Column, and also to convert them to JSON format.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getCsid()
String	getKey()
String	getName()
Map<String,Object>	getParameters()
int	hashCode()
String	toString()

Methods inherited from class Object

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

Method Detail

getCsid

@NotNull
public String getCsid()

getKey

@NotNull
public String getKey()

getName

@Nullable
public String getName()

getParameters

@NotNull
public Map<String,Object> getParameters()

Returns:

immutable map of column parameters

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object