Constructor Detail

• Str

  public Str()

Method Detail

• safe

  public static String safe(String name)

  Returns a String suitable to be used in multiple contexts, e.g., as part of a filename. The returned string will match [a-zA-Z0-9_-]+ Any characters outside this range will be replaced with an underscore, and multiple underscores will be collapsed down to a single underscore.

  Parameters:

  name - a string to make safe

  Returns:

• isSafe

  public static boolean isSafe(String name)

  Whether or not the given string matches [a-zA-Z0-9_-]+

  Parameters:

  name - the string to check

  Returns:

  true if it is safe, false otherwise

• ensureSafe

  public static void ensureSafe(String name)
                         throws Str.UnsafeName

  Throws an exception if the string does not match [a-zA-Z0-9_-]+, otherwise a no-op.

  Parameters:

  name - the string to check

  Throws:

  Str.UnsafeName - if the name is not safe