jenkins.model.item_category

Class ItemCategory

java.lang.Object

jenkins.model.item_category.ItemCategory

All Implemented Interfaces:

ExtensionPoint

Direct Known Subclasses:

ItemCategory.UncategorizedCategory, NestedProjectsCategory, StandaloneProjectsCategory

public abstract class ItemCategory
extends Object
implements ExtensionPoint

A category for Items.

Since:

2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ItemCategory.UncategorizedCategory The default ItemCategory, if an item doesn't belong anywhere else, this is where it goes by default.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static int	MIN_TOSHOW This field indicates how much non-default categories are required in order to start showing them in Jenkins.

Constructor Summary

Constructors

Constructor and Description
ItemCategory()

Method Summary

Modifier and Type	Method and Description
static ItemCategory	getCategory(TopLevelItemDescriptor descriptor) A ItemCategory associated to this TopLevelItemDescriptor.
abstract String	getDescription() The description in plain text
abstract String	getDisplayName() A human readable name.
abstract String	getId() Identifier, e.g.
abstract int	getMinToShow() Minimum number of items required to show the category.
int	getOrder()

Methods inherited from class java.lang.Object

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

Field Detail

MIN_TOSHOW

@Restricted(value=org.kohsuke.accmod.restrictions.NoExternalUse.class)
 @RestrictedSince(value="2.14")
public static final int MIN_TOSHOW

This field indicates how much non-default categories are required in order to start showing them in Jenkins. This field is restricted for the internal use only, because all other changes would cause binary compatibility issues. See JENKINS-36593 for more info.

See Also:

Constant Field Values

Constructor Detail

ItemCategory

public ItemCategory()

Method Detail

getId

public abstract String getId()

Identifier, e.g. "standaloneprojects", etc.

Returns:

the identifier

getDescription

public abstract String getDescription()

The description in plain text

Returns:

the description

getDisplayName

public abstract String getDisplayName()

A human readable name.

Returns:

the display name

getMinToShow

public abstract int getMinToShow()

Minimum number of items required to show the category.

Returns:

the minimum items required

getOrder

public int getOrder()

getCategory

@NonNull
public static ItemCategory getCategory(TopLevelItemDescriptor descriptor)

A ItemCategory associated to this TopLevelItemDescriptor.

Returns:

A ItemCategory, if not found, ItemCategory.UncategorizedCategory is returned