Package jenkins.branch

Enum MultiBranchProjectDisplayNamingStrategy

java.lang.Object

java.lang.Enum<MultiBranchProjectDisplayNamingStrategy>

jenkins.branch.MultiBranchProjectDisplayNamingStrategy

All Implemented Interfaces:

Serializable, Comparable<MultiBranchProjectDisplayNamingStrategy>

public enum MultiBranchProjectDisplayNamingStrategy
extends Enum<MultiBranchProjectDisplayNamingStrategy>

Possible Display naming strategies.

Since:

2.7.1

Enum Constant Summary

Enum Constants

Enum Constant	Description
OBJECT_DISPLAY_NAME	Use the display name (if available) sourced from the ObjectMetadataAction.
RAW_AND_OBJECT_DISPLAY_NAME	Use both the raw name and the display name from the ObjectMetadataAction (if available).

Method Summary

Modifier and Type	Method	Description
abstract String	generateName(String rawName, String displayName)
String	getDisplayName()
boolean	needsObjectDisplayName()
static MultiBranchProjectDisplayNamingStrategy	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MultiBranchProjectDisplayNamingStrategy[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OBJECT_DISPLAY_NAME

public static final MultiBranchProjectDisplayNamingStrategy OBJECT_DISPLAY_NAME

Use the display name (if available) sourced from the ObjectMetadataAction.

RAW_AND_OBJECT_DISPLAY_NAME

public static final MultiBranchProjectDisplayNamingStrategy RAW_AND_OBJECT_DISPLAY_NAME

Use both the raw name and the display name from the ObjectMetadataAction (if available).

Method Detail

values

public static MultiBranchProjectDisplayNamingStrategy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MultiBranchProjectDisplayNamingStrategy c : MultiBranchProjectDisplayNamingStrategy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MultiBranchProjectDisplayNamingStrategy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

needsObjectDisplayName

public boolean needsObjectDisplayName()

getDisplayName

public String getDisplayName()

generateName

public abstract String generateName(@NonNull
                                    String rawName,
                                    String displayName)