Package hudson.model.userproperty

Class UserPropertyCategory

java.lang.Object

hudson.model.userproperty.UserPropertyCategory

All Implemented Interfaces:

ExtensionPoint, ModelObject

Direct Known Subclasses:

UserPropertyCategory.Account, UserPropertyCategory.Appearance, UserPropertyCategory.Experimental, UserPropertyCategory.Invisible, UserPropertyCategory.Preferences, UserPropertyCategory.Security, UserPropertyCategory.Unclassified

public abstract class UserPropertyCategory
extends Object
implements ExtensionPoint, ModelObject

Grouping of related UserPropertys.

To facilitate the separation of the user properties into multiple pages, tabs, and so on, UserPropertys are classified into categories (such as "security", "preferences", as well as the catch-all "unclassified".) Categories themselves are extensible — plugins may introduce its own category as well, although that should only happen if you are creating a big enough subsystem.

Since:

2.468

See Also:

• UserProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UserPropertyCategory.Account	User property related to account settings (e.g.
static class	UserPropertyCategory.Appearance	User interface related configurations (e.g.
static class	UserPropertyCategory.Experimental	Per user feature flags (e.g.
static class	UserPropertyCategory.Invisible	For user properties that are not expected to be displayed, typically automatically configured by automated behavior, without direct user interaction.
static class	UserPropertyCategory.Preferences	Preferences related configurations (e.g.
static class	UserPropertyCategory.Security	Security related configurations (e.g.
static class	UserPropertyCategory.Unclassified	This category is used when the UserPropertyDescriptor has not implemented the UserPropertyDescriptor.getUserPropertyCategory() method (or the getUserPropertyCategoryAsString method for compatibility reason).

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
UserPropertyCategory()

Method Summary

Modifier and Type	Method	Description
static ExtensionList<UserPropertyCategory>	all()	Returns all the registered UserPropertyCategory descriptors.
static <T extends UserPropertyCategory> T	get(Class<T> type)
abstract String	getShortDescription()	One-line plain text message that explains what this category is about.

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.ModelObject

getDisplayName

Constructor Details

UserPropertyCategory

public UserPropertyCategory()

Method Details

getShortDescription

public abstract String getShortDescription()

One-line plain text message that explains what this category is about. This can be used in the UI to help the user pick the right category. The text should be longer than ModelObject.getDisplayName()

all

public static ExtensionList<UserPropertyCategory> all()

Returns all the registered UserPropertyCategory descriptors.

get

@NonNull
public static <T extends UserPropertyCategory> T get(Class<T> type)