Package jenkins.model

Class IdStrategy.CaseInsensitive

java.lang.Object
hudson.model.AbstractDescribableImpl<IdStrategy>
jenkins.model.IdStrategy
jenkins.model.IdStrategy.CaseInsensitive
All Implemented Interfaces:
ExtensionPoint, Describable<IdStrategy>, Serializable, Comparator<String>
Enclosing class:
IdStrategy
public static class IdStrategy.CaseInsensitive extends IdStrategy implements Serializable
The default case insensitive IdStrategy
See Also:

  • Constructor Details

    • CaseInsensitive

      @DataBoundConstructor public CaseInsensitive()

  • Method Details

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

    • keyFor

      @NonNull public String keyFor(@NonNull String id)
      Description copied from class: IdStrategy
      Converts an ID into a key for use in a Java Map or similar. This controls uniqueness of ids and how multiple different ids may map to the same id. For example, all different capitalizations of "Foo" may map to the same value "foo".
      Overrides:
      keyFor in class IdStrategy
      Parameters:
      id - the id.
      Returns:
      the key.

    • equals

      public boolean equals(@NonNull String id1, @NonNull String id2)
      Description copied from class: IdStrategy
      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. Subclasses may want to override this naïve implementation that calls compare(id1, id2) == 0 for a more performant implementation.
      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.

    • compare

      public int compare(@NonNull String id1, @NonNull String id2)
      Description copied from class: IdStrategy
      Compare two 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.