jenkins.model

Class IdStrategy.CaseSensitive

java.lang.Object

hudson.model.AbstractDescribableImpl<IdStrategy>

jenkins.model.IdStrategy

jenkins.model.IdStrategy.CaseSensitive

All Implemented Interfaces:

ExtensionPoint, Describable<IdStrategy>, Comparator<String>

Direct Known Subclasses:

IdStrategy.CaseSensitiveEmailAddress

Enclosing class:

IdStrategy

public static class IdStrategy.CaseSensitive
extends IdStrategy

A case sensitive IdStrategy

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IdStrategy.CaseSensitive.DescriptorImpl

Nested classes/interfaces inherited from class jenkins.model.IdStrategy

IdStrategy.CaseInsensitive, IdStrategy.CaseSensitive, IdStrategy.CaseSensitiveEmailAddress

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class jenkins.model.IdStrategy

CASE_INSENSITIVE

Constructor Summary

Constructors

Constructor and Description
CaseSensitive()

Method Summary

Modifier and Type	Method and Description
int	compare(String id1, String id2) Compare tow IDs and return their sorting order.
boolean	equals(String id1, String id2) Compare two IDs and return true IFF the two ids are the same.
String	filenameOf(String id) Converts an ID into a name for use as a filename.
String	idFromFilename(String filename) Converts a filename into the corresponding id.
String	keyFor(String id) Converts an ID into a key for use in a Java Map.
String	legacyFilenameOf(String id) Converts an ID into a name for use as a filename.

Methods inherited from class jenkins.model.IdStrategy

all, equals, getDescriptor, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

CaseSensitive

@DataBoundConstructor
public CaseSensitive()

Method Detail

filenameOf

@Nonnull
public String filenameOf(@Nonnull
                                  String id)

Converts an ID into a name for use as a filename. The return value must not contain any filesystem unsafe characters or names. See https://msdn.microsoft.com/en-us/library/aa365247.aspx for information on reserved names.

Specified by:

filenameOf in class IdStrategy

Parameters:

id - the id.

Returns:

the name. Must be filesystem safe.

legacyFilenameOf

@Nonnull
public String legacyFilenameOf(@Nonnull
                                        String id)

Converts an ID into a name for use as a filename. Legacy implementation used only for migrating old style config files to the new implementation.

Overrides:

legacyFilenameOf in class IdStrategy

Parameters:

id - the id

Returns:

the name

idFromFilename

public String idFromFilename(@Nonnull
                             String filename)

Description copied from class: IdStrategy

Converts a filename into the corresponding id. This may contain filesystem unsafe characters.

Overrides:

idFromFilename in class IdStrategy

Parameters:

filename - the filename.

Returns:

the corresponding id.

equals

public boolean equals(@Nonnull
                      String id1,
                      @Nonnull
                      String id2)

Compare two IDs and return true IFF the two ids are the same. Normally we expect that this should be the same as IdStrategy.compare(String, String) being equal to 0, however there may be a specific reason for going beyond that, such as sorting id's case insensitively while treating them as case sensitive.

Overrides:

equals in class IdStrategy

Parameters:

id1 - the first id.

id2 - the second id.

Returns:

true if and only if the two ids are the same.

keyFor

@Nonnull
public String keyFor(@Nonnull
                              String id)

Converts an ID into a key for use in a Java Map.

Specified by:

keyFor in class IdStrategy

Parameters:

id - the id.

Returns:

the key.

compare

public int compare(@Nonnull
                   String id1,
                   @Nonnull
                   String id2)

Compare tow IDs and return their sorting order. If IdStrategy.equals(String, String) is true then this must return 0 but IdStrategy.compare(String, String) returning 0 need not imply that IdStrategy.equals(String, String) is true.

Specified by:

compare in interface Comparator<String>

Specified by:

compare in class IdStrategy

Parameters:

id1 - the first id.

id2 - the second id.

Returns:

the sorting order of the two IDs.