Package jenkins.scm.api

Class SCMNavigatorDescriptor

java.lang.Object

hudson.model.Descriptor<SCMNavigator>

jenkins.scm.api.SCMNavigatorDescriptor

All Implemented Interfaces:

Saveable, OnMaster, IconSpec

Direct Known Subclasses:

SingleSCMNavigator.DescriptorImpl

public abstract class SCMNavigatorDescriptor
extends Descriptor<SCMNavigator>
implements 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	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	Description
protected	SCMNavigatorDescriptor()
protected	SCMNavigatorDescriptor(Class<? extends SCMNavigator> clazz)

Method Summary

Modifier and Type	Method	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()	Deprecated. No longer used.
String	getDescription()	Deprecated. No longer used.
String	getIconClassName()	Get the Item's Icon class specification e.g.
String	getIconFilePathPattern()	Deprecated. No longer used.
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.
SCMNavigator	newInstance(String name)	Deprecated. No longer used.

Methods inherited from class hudson.model.Descriptor

addHelpFileRedirect, bindJSON, 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, getRequiredGlobalConfigPagePermission, 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

@Deprecated
@NonNull
public String getDescription()

Deprecated.

No longer used.

getCategoryId

@Deprecated
@NonNull
public String getCategoryId()

Deprecated.

No longer used.

getIconFilePathPattern

@Deprecated
@CheckForNull
public String getIconFilePathPattern()

Deprecated.

No longer used.

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 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

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

Deprecated.

No longer used.