com.almworks.jira.structure.api.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of structure-api Show documentation

Public API for the Structure Plugin for JIRA

There is a newer version: 17.25.3

/**
 * This package and subpackages contain Structure API, which can be used to integrate with and extend Structure add-on for JIRA.
 *
 * The packages contains different types of classes:
 * 
 *   To use Structure, make calls to API classes, marked with {@link com.atlassian.annotations.PublicApi}.
 *   To extend Structure's functionality, extend SPI classes, marked with {@link com.atlassian.annotations.PublicSpi}.
 *   There are classes marked {@link com.atlassian.annotations.Internal} — you can use those, but backwards
 *   compatibility is not guaranteed in minor updates.
 * 
 *
 * You can read more about versioning and the distinction between the API, SPI and Internal classes in
 * Structure Developer's Guide.
 *
 * 
 *   All main services are available as injectable parameters
 *   or through {@link com.almworks.jira.structure.api.StructureComponents}.
 * 
 * 
 *   The following is the list of major services you might need to work with:
 * 
 * 
 * {@link com.almworks.jira.structure.api.structure.StructureManager} lets you create, find, update and delete
 * structures. Note that it does not provide access to the structures' content, only to the properties like name and
 * description.
 * {@link com.almworks.jira.structure.api.forest.ForestService} allows you to retrieve and update a structure's content.
 * It also can be used to transform structures or to run queries.
 * {@link com.almworks.jira.structure.api.folder.FolderManager} and {@link com.almworks.jira.structure.api.generator.GeneratorManager}
 * let you create and manage folders and generators.
 * Use {@link com.almworks.jira.structure.api.item.CoreIdentities} to create {@link com.almworks.jira.structure.api.item.ItemIdentity}
 * instances for issues and other well-known types.
 * {@link com.almworks.jira.structure.api.row.RowManager} lets you retrieve {@link com.almworks.jira.structure.api.row.StructureRow}
 *  by row ID and extract item ID from it.
 * Use {@link com.almworks.jira.structure.api.sync.StructureSyncManager} to install and configure synchronizers.
 * Use {@link com.almworks.jira.structure.api.view.StructureViewManager} to work with views.
 * 
 */
package com.almworks.jira.structure.api;