Package com.almworks.jira.structure.api.view

Class ViewSpecification

Object

ViewSpecification

@PublicApi
public class ViewSpecification
extends Object

ViewSpecification represents the visual configuration of a structure grid. It is usually part of the StructureView, which also has a name and description for a view specification, but it can also exist by itself.

View specification contains the following properties:

• List of columns that are displayed by the Structure widget -- see ViewSpecification.Column
• Column display mode that is used by default for the view -- see ColumnDisplayMode

This class is an immutable representation of the view. You can also use ViewSpecification.Builder class to build or modify a view specification, or to convert it into JSON format for transfer or storage.

This class is thread-safe by the merit of immutability.

Author:

Igor Sereda

See Also:

• ViewSpecification.Column
• ViewSpecification.Builder
• StructureView

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ViewSpecification.Builder	A builder for ViewSpecification, also used to serialize view specification into JSON.
static class	ViewSpecification.Column	Represents a single column configuration in the Structure widget.

Field Summary

Fields

Modifier and Type	Field	Description
static final ViewSpecification	EMPTY	Empty specification that does not contain any columns.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	getColumnDisplayMode()
List<ViewSpecification.Column>	getColumns()
List<String>	getPins()
int	getRowDisplayMode()
int	hashCode()
String	toString()

Methods inherited from class Object

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

Field Details

EMPTY

public static final ViewSpecification EMPTY

Empty specification that does not contain any columns. Used as fallback instance where not null view specification is required.

Method Details

getColumns

@NotNull
public List<ViewSpecification.Column> getColumns()

Returns:

a list of columns, not null

getColumnDisplayMode

public int getColumnDisplayMode()

Returns:

the current column display mode - see ColumnDisplayMode

getRowDisplayMode

public int getRowDisplayMode()

Returns:

the current row display mode - see RowDisplayMode

getPins

@NotNull
public List<String> getPins()

Returns:

a list of pinned columns csid, not null

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