jenkins.model

Class IdStrategy

java.lang.Object

hudson.model.AbstractDescribableImpl<IdStrategy>

jenkins.model.IdStrategy

All Implemented Interfaces:

ExtensionPoint, Describable<IdStrategy>, Comparator<String>

Direct Known Subclasses:

IdStrategy.CaseInsensitive, IdStrategy.CaseSensitive

public abstract class IdStrategy
extends AbstractDescribableImpl<IdStrategy>
implements ExtensionPoint, Comparator<String>

The strategy to use for manipulating converting names (e.g. user names, group names, etc) into ids.

Since:

1.566

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IdStrategy.CaseInsensitive The default case insensitive IdStrategy
static class	IdStrategy.CaseSensitive A case sensitive IdStrategy
static class	IdStrategy.CaseSensitiveEmailAddress A case sensitive email address IdStrategy.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static IdStrategy	CASE_INSENSITIVE The default case insensitive strategy.

Constructor Summary

Constructors

Constructor and Description
IdStrategy()

Method Summary

Modifier and Type	Method and Description
static DescriptorExtensionList<IdStrategy,IdStrategyDescriptor>	all() Returns all the registered IdStrategy descriptors.
abstract int	compare(String id1, String id2) Compare tow IDs and return their sorting order.
boolean	equals(Object obj) This method is used to decide whether a User.rekey() operation is required.
boolean	equals(String id1, String id2) Compare two IDs and return true IFF the two ids are the same.
abstract String	filenameOf(String id) Converts an ID into a name for use as a filename.
IdStrategyDescriptor	getDescriptor() By default looks for a nested class (conventionally named DescriptorImpl) implementing Descriptor and marked with Extension.
int	hashCode()
String	idFromFilename(String filename) Converts a filename into the corresponding id.
abstract 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.
String	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

Field Detail

CASE_INSENSITIVE

public static IdStrategy CASE_INSENSITIVE

The default case insensitive strategy.

Constructor Detail

IdStrategy

public IdStrategy()

Method Detail

filenameOf

@Nonnull
public abstract 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.

Parameters:

id - the id.

Returns:

the name. Must be filesystem safe.

legacyFilenameOf

@Nonnull
 @Restricted(value=org.kohsuke.accmod.restrictions.ProtectedExternally.class)
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.

Parameters:

id - the id

Returns:

the name

idFromFilename

public String idFromFilename(@Nonnull
                             String filename)

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

Parameters:

filename - the filename.

Returns:

the corresponding id.

Since:

1.577

keyFor

@Nonnull
public abstract String keyFor(@Nonnull
                                       String id)

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

Parameters:

id - the id.

Returns:

the key.

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

Parameters:

id1 - the first id.

id2 - the second id.

Returns:

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

compare

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

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

Specified by:

compare in interface Comparator<String>

Parameters:

id1 - the first id.

id2 - the second id.

Returns:

the sorting order of the two IDs.

getDescriptor

public IdStrategyDescriptor getDescriptor()

By default looks for a nested class (conventionally named DescriptorImpl) implementing Descriptor and marked with Extension.

Gets the descriptor for this instance.

Descriptor is a singleton for every concrete Describable implementation, so if a.getClass() == b.getClass() then by default a.getDescriptor() == b.getDescriptor() as well. (In rare cases a single implementation class may be used for instances with distinct descriptors.)

Specified by:

getDescriptor in interface Describable<IdStrategy>

Overrides:

getDescriptor in class AbstractDescribableImpl<IdStrategy>

equals

public boolean equals(Object obj)

This method is used to decide whether a User.rekey() operation is required.

Specified by:

equals in interface Comparator<String>

Overrides:

equals in class Object

Parameters:

obj - the object to compare with.

Returns:

true if and only if this is the same as obj.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

all

public static DescriptorExtensionList<IdStrategy,IdStrategyDescriptor> all()

Returns all the registered IdStrategy descriptors.