jenkins.scm.api

Class SCMNavigatorDescriptor

java.lang.Object

hudson.model.Descriptor<SCMNavigator>

jenkins.scm.api.SCMNavigatorDescriptor

All Implemented Interfaces:

Saveable, OnMaster, org.jenkins.ui.icon.IconSpec

Direct Known Subclasses:

SingleSCMNavigator.DescriptorImpl

public abstract class SCMNavigatorDescriptor
extends Descriptor<SCMNavigator>
implements org.jenkins.ui.icon.IconSpec

Definition of a kind of SCMNavigator.

Since:

0.3-beta-1

Nested Class Summary

Nested classes/interfaces inherited from class hudson.model.Descriptor

Descriptor.FormException, Descriptor.PropertyType, Descriptor.Self

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<SCMSourceCategory>	categories The set of SCMSourceCategory singletons for this type of SCMNavigator

Fields inherited from class hudson.model.Descriptor

clazz

Fields inherited from interface hudson.model.Saveable

NOOP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SCMNavigatorDescriptor()
protected	SCMNavigatorDescriptor(Class<? extends SCMNavigator> clazz)

Method Summary

Modifier and Type	Method and Description
protected SCMSourceCategory[]	createCategories() Creates the singleton SCMSourceCategory instances that this type of SCMNavigator is capable of producing.
Set<SCMSourceCategory>	getCategories() Returns the set of SCMSourceCategory that this SCMNavigator supports.
String	getCategoryId() Used to categorize this kind of SCMNavigator.
String	getDescription() A description of this kind of SCMNavigator.
String	getIconClassName() Get the Item's Icon class specification e.g.
String	getIconFilePathPattern() Represents a file path pattern to get the Item icon in different sizes.
String	getPronoun() Get the term used in the UI to represent this kind of SCMNavigator.
List<SCMTrait<? extends SCMTrait<?>>>	getTraitsDefaults() Returns the default traits for this SCMSource.
abstract SCMNavigator	newInstance(String name) Creates a default navigator, if there should be one displayed.

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, calcAutoCompleteSettings, calcFillSettings, configure, configure, doHelp, find, find, findByDescribableClassName, findById, getCategory, getCheckMethod, getCheckUrl, getConfigFile, getConfigPage, getCurrentDescriptorByNameUrl, getDescriptorFullUrl, getDescriptorUrl, getDisplayName, getGlobalConfigPage, getGlobalPropertyType, getHelpFile, getHelpFile, getHelpFile, getId, getJsonSafeClassName, getKlass, getPlugin, getPossibleViewNames, getPropertyType, getPropertyType, getPropertyTypeOrDie, getT, getViewPage, isInstance, isSubTypeOf, load, newInstance, newInstance, newInstancesFromHeteroList, newInstancesFromHeteroList, save, self, toArray, toList, toMap

Methods inherited from class java.lang.Object

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

Field Detail

categories

protected transient Set<SCMSourceCategory> categories

The set of SCMSourceCategory singletons for this type of SCMNavigator

Since:

2.0

See Also:

getCategories()

Constructor Detail

SCMNavigatorDescriptor

protected SCMNavigatorDescriptor()

SCMNavigatorDescriptor

protected SCMNavigatorDescriptor(Class<? extends SCMNavigator> clazz)

Method Detail

getTraitsDefaults

@NonNull
public List<SCMTrait<? extends SCMTrait<?>>> getTraitsDefaults()

Returns the default traits for this SCMSource.

Returns:

An empty list if not overridden.

getDescription

@NonNull
public String getDescription()

A description of this kind of SCMNavigator. This description can contain HTML code but it is recommended to use text plain in order to avoid how it should be represented.

Returns:

A string with the description. TopLevelItemDescriptor#getDescription(). TODO: Replace to @link when the baseline is upgraded to 2.x

Since:

1.2

getCategoryId

@NonNull
public String getCategoryId()

Used to categorize this kind of SCMNavigator.

Returns:

A string with the category identifier. TopLevelItemDescriptor#getCategoryId() TODO: Replace to @link when the baseline is upgraded to 2.x

Since:

1.2

getIconFilePathPattern

@CheckForNull
public String getIconFilePathPattern()

Represents a file path pattern to get the Item icon in different sizes. For example: plugin/plugin-shortname/images/:size/item.png, where :size represents the different icon sizes used commonly in Jenkins project: 16x16, 24x24, 32x32 or 48x48

Returns:

A string or null if it is not defined. TopLevelItemDescriptor#getIconFilePathPattern() TODO: Replace to @link when the baseline is upgraded to 2.x

Since:

1.2

getIconClassName

@CheckForNull
public String getIconClassName()

Get the Item's Icon class specification e.g. 'icon-notepad'. Note: do NOT include icon size specifications (such as 'icon-sm').

Specified by:

getIconClassName in interface org.jenkins.ui.icon.IconSpec

Returns:

The Icon class specification e.g. 'icon-notepad'.

getPronoun

@CheckForNull
public String getPronoun()

Get the term used in the UI to represent this kind of SCMNavigator. Must start with a capital letter.

Returns:

the term or null to fall back to the calling context's default.

Since:

2.0

getCategories

@NonNull
public final Set<SCMSourceCategory> getCategories()

Returns the set of SCMSourceCategory that this SCMNavigator supports. There will always be exactly one SCMCategory.isUncategorized() instance in the returned set.

Returns:

the set of SCMSourceCategory that this SCMNavigator supports.

Since:

2.0

See Also:

createCategories()

createCategories

@NonNull
protected SCMSourceCategory[] createCategories()

Creates the singleton SCMSourceCategory instances that this type of SCMNavigator is capable of producing.

Returns:

the singleton SCMSourceCategory instances for this type of SCMNavigator

Since:

2.0

See Also:

getCategories()

newInstance

@CheckForNull
public abstract SCMNavigator newInstance(@CheckForNull
                                                       String name)

Creates a default navigator, if there should be one displayed. May be interpreted by jenkins.branch.CustomOrganizationFolderDescriptor. If returning non-null, you should also provide a getDescription() implementation

Parameters:

name - a name supplied by the user which may be used as a hint for preconfiguration

Returns:

a navigator with a default configuration, or null if it should not be advertised this way