org.yatech.common.args

Class CollectionArgs

java.lang.Object

org.yatech.common.args.CollectionArgs

public abstract class CollectionArgs
extends java.lang.Object

A utility class for common methods on arguments of type Collection

Method Summary

Modifier and Type	Method and Description
static <C extends java.util.Collection<E>,E> C	requireContains(C collection, E element, java.lang.String message) Require that a given collection contain a specific element
static <M extends java.util.Map<K,V>,K,V> M	requireContainsKey(M map, K key, java.lang.String message) Require that a given map contain a specific key
static <M extends java.util.Map<K,V>,K,V> M	requireContainsValue(M map, V value, java.lang.String message) Require that a given map contain a specific value
static <C extends java.util.Collection<E>,E> C	requireEmpty(C collection, java.lang.String message) Require that a given collection is empty
static <M extends java.util.Map<K,V>,K,V> M	requireEmpty(M map, java.lang.String message) Require that a given map is empty
static <C extends java.util.Collection<E>,E> C	requireExcludes(C collection, E element, java.lang.String message) Require that a given collection does not contain a specific element
static <M extends java.util.Map<K,V>,K,V> M	requireExcludesKey(M map, K key, java.lang.String message) Require that a given map does not contain a specific key
static <M extends java.util.Map<K,V>,K,V> M	requireExcludesValue(M map, V value, java.lang.String message) Require that a given map does not contain a specific value
static <C extends java.util.Collection<E>,E> C	requireMaxSize(C collection, int size, java.lang.String message) Require that a given collection does not exceed a max size
static <M extends java.util.Map<K,V>,K,V> M	requireMaxSize(M map, int size, java.lang.String message) Require that a given map does not exceed a max size
static <C extends java.util.Collection<E>,E> C	requireMinSize(C collection, int size, java.lang.String message) Require that a given collection has a minimum size
static <M extends java.util.Map<K,V>,K,V> M	requireMinSize(M map, int size, java.lang.String message) Require that a given map has a minimum size
static <C extends java.util.Collection<E>,E> C	requireNonEmpty(C collection, java.lang.String message) Require that a given collection is not empty
static <M extends java.util.Map<K,V>,K,V> M	requireNonEmpty(M map, java.lang.String message) Require that a given map is not empty

Methods inherited from class java.lang.Object

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

Method Detail

requireContains

@Nonnull
public static <C extends java.util.Collection<E>,E> C requireContains(C collection,
                                                                               E element,
                                                                               @Nonnull
                                                                               java.lang.String message)

Require that a given collection contain a specific element

Type Parameters:

C - the collection type

E - the element type

Parameters:

collection - the collection to check

element - the required element

message - the error message

Returns:

the collection if the requirement is satisfied

requireContainsKey

@Nonnull
public static <M extends java.util.Map<K,V>,K,V> M requireContainsKey(M map,
                                                                               K key,
                                                                               @Nonnull
                                                                               java.lang.String message)

Require that a given map contain a specific key

Type Parameters:

M - the map type

K - the key type

V - the value type

Parameters:

map - the map to check

key - the required key

message - the error message

Returns:

the map if the requirement is satisfied

requireContainsValue

@Nonnull
public static <M extends java.util.Map<K,V>,K,V> M requireContainsValue(M map,
                                                                                 V value,
                                                                                 @Nonnull
                                                                                 java.lang.String message)

Require that a given map contain a specific value

Type Parameters:

M - the map type

K - the key type

V - the value type

Parameters:

map - the map to check

value - the required value

message - the error message

Returns:

the map if the requirement is satisfied

requireExcludes

@Nonnull
public static <C extends java.util.Collection<E>,E> C requireExcludes(C collection,
                                                                               E element,
                                                                               @Nonnull
                                                                               java.lang.String message)

Require that a given collection does not contain a specific element

Type Parameters:

C - the collection type

E - the element type

Parameters:

collection - the collection to check

element - the element to exclude

message - the error message

Returns:

the collection if the requirement is satisfied

requireExcludesKey

@Nonnull
public static <M extends java.util.Map<K,V>,K,V> M requireExcludesKey(M map,
                                                                               K key,
                                                                               @Nonnull
                                                                               java.lang.String message)

Require that a given map does not contain a specific key

Type Parameters:

M - the map type

K - the key type

V - the value type

Parameters:

map - the map to check

key - the key to exclude

message - the error message

Returns:

the map if the requirement is satisfied

requireExcludesValue

@Nonnull
public static <M extends java.util.Map<K,V>,K,V> M requireExcludesValue(M map,
                                                                                 V value,
                                                                                 @Nonnull
                                                                                 java.lang.String message)

Require that a given map does not contain a specific value

Type Parameters:

M - the map type

K - the key type

V - the value type

Parameters:

map - the map to check

value - the value to exclude

message - the error message

Returns:

the map if the requirement is satisfied

requireMaxSize

@Nonnull
public static <C extends java.util.Collection<E>,E> C requireMaxSize(C collection,
                                                                              int size,
                                                                              @Nonnull
                                                                              java.lang.String message)

Require that a given collection does not exceed a max size

Type Parameters:

C - the collection type

E - the element type

Parameters:

collection - the collection to check

size - the maximum size

message - the error message

Returns:

the collection if the requirement is satisfied

requireMaxSize

@Nonnull
public static <M extends java.util.Map<K,V>,K,V> M requireMaxSize(M map,
                                                                           int size,
                                                                           @Nonnull
                                                                           java.lang.String message)

Require that a given map does not exceed a max size

Type Parameters:

M - the map type

K - the key type

V - the value type

Parameters:

map - the map to check

size - the maximum size

message - the error message

Returns:

the map if the requirement is satisfied

requireEmpty

@Nonnull
public static <C extends java.util.Collection<E>,E> C requireEmpty(C collection,
                                                                            @Nonnull
                                                                            java.lang.String message)

Require that a given collection is empty

Type Parameters:

C - the collection type

E - the element type

Parameters:

collection - the collection to check

message - the error message

Returns:

the collection if the requirement is satisfied

requireEmpty

@Nonnull
public static <M extends java.util.Map<K,V>,K,V> M requireEmpty(M map,
                                                                         @Nonnull
                                                                         java.lang.String message)

Require that a given map is empty

Type Parameters:

M - the map type

K - the key type

V - the value type

Parameters:

map - the map to check

message - the error message

Returns:

the map if the requirement is satisfied

requireMinSize

@Nonnull
public static <C extends java.util.Collection<E>,E> C requireMinSize(C collection,
                                                                              int size,
                                                                              @Nonnull
                                                                              java.lang.String message)

Require that a given collection has a minimum size

Type Parameters:

C - the collection type

E - the element type

Parameters:

collection - the collection to check

size - the minimum size

message - the error message

Returns:

the collection if the requirement is satisfied

requireMinSize

@Nonnull
public static <M extends java.util.Map<K,V>,K,V> M requireMinSize(M map,
                                                                           int size,
                                                                           @Nonnull
                                                                           java.lang.String message)

Require that a given map has a minimum size

Type Parameters:

M - the map type

K - the key type

V - the value type

Parameters:

map - the map to check

size - the minimum size

message - the error message

Returns:

the map if the requirement is satisfied

requireNonEmpty

@Nonnull
public static <C extends java.util.Collection<E>,E> C requireNonEmpty(C collection,
                                                                               @Nonnull
                                                                               java.lang.String message)

Require that a given collection is not empty

Type Parameters:

C - the collection type

E - the element type

Parameters:

collection - the collection to check

message - the error message

Returns:

the collection if the requirement is satisfied

requireNonEmpty

@Nonnull
public static <M extends java.util.Map<K,V>,K,V> M requireNonEmpty(M map,
                                                                            @Nonnull
                                                                            java.lang.String message)

Require that a given map is not empty

Type Parameters:

M - the map type

K - the key type

V - the value type

Parameters:

map - the map to check

message - the error message

Returns:

the map if the requirement is satisfied