com.atlassian.vcache.internal

Class NameValidator

java.lang.Object

com.atlassian.vcache.internal.NameValidator

public class NameValidator
extends Object

Provides utility methods to validate a name as being legitimate for use with VCache.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
NameValidator()

Method Summary

Modifier and Type	Method and Description
static boolean	isValidCacheName(String name) Returns whether the specified name is valid for a cache.
static boolean	isValidKeyName(String name) Returns whether the specified name is valid for a key.
static boolean	isValidPartitionIdentifier(String name) Returns whether the specified name is valid for a partition identifier.
static boolean	isValidProductIdentifier(String name) Returns whether the specified name is valid for a product identifier.
static String	requireValidCacheName(String name) Verifies that the specified name is valid for a cache, and throws an IllegalArgumentException if it not.
static String	requireValidKeyName(String name) Verifies that the specified name is valid for a key, and throws an IllegalArgumentException if it not.
static String	requireValidPartitionIdentifier(String name) Verifies that the specified name is valid for a partition identifier, and throws an IllegalArgumentException if it not.
static String	requireValidProductIdentifier(String name) Verifies that the specified name is valid for a product identifier, and throws an IllegalArgumentException if it not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NameValidator

public NameValidator()

Method Detail

isValidProductIdentifier

public static boolean isValidProductIdentifier(@Nullable
                                               String name)

Returns whether the specified name is valid for a product identifier.

Parameters:

name - the name to check

Returns:

whether the specified name is valid for a product identifier.

requireValidProductIdentifier

public static String requireValidProductIdentifier(@Nullable
                                                   String name)

Verifies that the specified name is valid for a product identifier, and throws an IllegalArgumentException if it not.

Parameters:

name - the name to verify

Returns:

the name if it is valid

isValidPartitionIdentifier

public static boolean isValidPartitionIdentifier(@Nullable
                                                 String name)

Returns whether the specified name is valid for a partition identifier.

Parameters:

name - the name to check

Returns:

whether the specified name is valid for a partition identifier.

requireValidPartitionIdentifier

public static String requireValidPartitionIdentifier(@Nullable
                                                     String name)

Verifies that the specified name is valid for a partition identifier, and throws an IllegalArgumentException if it not.

Parameters:

name - the name to verify

Returns:

the name if it is valid

isValidKeyName

public static boolean isValidKeyName(@Nullable
                                     String name)

Returns whether the specified name is valid for a key.

Parameters:

name - the name to check

Returns:

whether the specified name is valid for a key.

requireValidKeyName

public static String requireValidKeyName(@Nullable
                                         String name)

Verifies that the specified name is valid for a key, and throws an IllegalArgumentException if it not.

Parameters:

name - the name to verify

Returns:

the name if it is valid

isValidCacheName

public static boolean isValidCacheName(String name)

Returns whether the specified name is valid for a cache.

Parameters:

name - the name to check

Returns:

whether the specified name is valid for a cache.

requireValidCacheName

public static String requireValidCacheName(String name)

Verifies that the specified name is valid for a cache, and throws an IllegalArgumentException if it not.

Parameters:

name - the name to verify

Returns:

the name if it is valid