Class UniqueNameGenerationHelper

java.lang.Object
de.xima.fc.copy.UniqueNameGenerationHelper
@Deprecated public class UniqueNameGenerationHelper extends Object
Deprecated.
Use UniqueNameGenerationHelper instead.
Helper class for generating unique names. Lets you customize the name generation process, e.g. by setting a maximum length for the name, a validity check for the generated names, or a sanitizer for the names.

For example, sometimes a new name needs to be generated for an entity, but not all names are allowed. This class helps to generate new unique names with an index and returns the first name it finds that passes the given validity check. Could be used, for example, to create a new name for a copied project, e.g. My Project_Copy_9.

Since:
8.3.0
Author:
XIMA MEDIA GmbH

  • Constructor Details

    • UniqueNameGenerationHelper

      public UniqueNameGenerationHelper()
      Deprecated.

  • Method Details

    • generateNewName

      public static String generateNewName(String originalName, UniqueNameGenerationHelper.NameGenerationOptions options) throws LimitExceededException
      Deprecated.
      Sometimes a new name needs to be generated for an entity, but not all names are allowed. This method generates new names with an index and returns the first name it finds that passes the given validity check. May be used, for example, to create a new name for a copied project, e.g. My Project_Copy_9.
      Parameters:
      originalName - Original name.
      options - options for generating the new name
      Returns:
      A new name that passes the validity check.
      Throws:
      LimitExceededException - When no new unique name could be generated.