at.meks.validation.validations.list

Class ListValidationsWithErrorCode

java.lang.Object

at.meks.validation.validations.list.ListValidationsWithErrorCode

public class ListValidationsWithErrorCode
extends Object

This class provides validations for lists with the support of error codes. The error code ist always part of the validation result in the case of an validation violation. The methods always create new validation instances.

Method Summary

Modifier and Type	Method and Description
static <T> Validation<List<T>>	contains(java.util.function.Supplier<T> containedValue, String errorCode) validates that a list contains at least one entry which matches to the provided arg.
static <T> Validation<List<T>>	contains(T containedValue, String errorCode) validates that a list contains at least one entry which matches to the provided arg.
static <T> Validation<List<T>>	containsOnly(java.util.function.Supplier<T> containedValue, String errorCode) validates that a list contains only entries which match to the provided arg.
static <T> Validation<List<T>>	containsOnly(T containedValue, String errorCode) validates that a list contains only entries which match to the provided arg.
static <T> Validation<List<T>>	doesNotContain(java.util.function.Supplier<T> excludedValue, String errorCode) validates that a list does not contain an entry which matches the provided arg.
static <T> Validation<List<T>>	doesNotContain(T excludedValue, String errorCode) validates that a list does not contain an entry which matches the provided arg.
static <T> Validation<List<T>>	forType(Class<T> listType, Validation<List<T>> validation) sadly this method is needed if you want to start with general validations on lists, like the notEmpty, and afterwards the entries should be validated by a property.
static <T> Validation<List<T>>	hasMaxSize(int size, String errorCode) validates that a list has an expected maximum size.
static <T> Validation<List<T>>	hasMaxSize(java.util.function.Supplier<Integer> size, String errorCode) validates that a list has an expected maximum size.
static <T> Validation<List<T>>	hasMinSize(int size, String errorCode) validates that a list has an expected minimum size.
static <T> Validation<List<T>>	hasMinSize(java.util.function.Supplier<Integer> size, String errorCode) validates that a list has an expected minimum size.
static <T> Validation<List<T>>	hasSize(int size, String errorCode) validates that a list has an expected size.
static <T> Validation<List<T>>	hasSize(java.util.function.Supplier<Integer> size, String errorCode) validates that a list has an expected size.
static <T> Validation<List<T>>	isEmpty(String errorCode) validates that a list is empty.
static <T> Validation<List<T>>	isNotEmpty(String errorCode) validates that a list isn't empty.
static <T,E> Validation<List<T>>	onProperty(java.util.function.Function<T,E> function, Validation<List<E>> validation) validation for a property of the list entries.

Methods inherited from class java.lang.Object

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

Method Detail

containsOnly

public static <T> Validation<List<T>> containsOnly(T containedValue,
                                                   String errorCode)

validates that a list contains only entries which match to the provided arg.

Type Parameters:

T - the type of the list

Parameters:

containedValue - the only value which is allowed in the list

errorCode - error code used incase of an violation

Returns:

new instance of list validation

containsOnly

public static <T> Validation<List<T>> containsOnly(java.util.function.Supplier<T> containedValue,
                                                   String errorCode)

validates that a list contains only entries which match to the provided arg.

Type Parameters:

T - the type of the list

Parameters:

containedValue - the only value which is allowed in the list

errorCode - error code used incase of an violation

Returns:

new instance of list validation

contains

public static <T> Validation<List<T>> contains(T containedValue,
                                               String errorCode)

validates that a list contains at least one entry which matches to the provided arg.

Type Parameters:

T - the type of the list

Parameters:

containedValue - the value which must exist in the list

errorCode - error code used incase of an violation

Returns:

new instance of list validation

contains

public static <T> Validation<List<T>> contains(java.util.function.Supplier<T> containedValue,
                                               String errorCode)

validates that a list contains at least one entry which matches to the provided arg.

Type Parameters:

T - the type of the list

Parameters:

containedValue - the value which must exist in the list

errorCode - error code used incase of an violation

Returns:

new instance of list validation

doesNotContain

public static <T> Validation<List<T>> doesNotContain(T excludedValue,
                                                     String errorCode)

validates that a list does not contain an entry which matches the provided arg.

Type Parameters:

T - the type of the list

Parameters:

excludedValue - the value which mustn't exists in the list

errorCode - error code used incase of an violation

Returns:

new instance of list validation

doesNotContain

public static <T> Validation<List<T>> doesNotContain(java.util.function.Supplier<T> excludedValue,
                                                     String errorCode)

validates that a list does not contain an entry which matches the provided arg.

Type Parameters:

T - the type of the list

Parameters:

excludedValue - the value which mustn't exists in the list

errorCode - error code used incase of an violation

Returns:

new instance of list validation

isNotEmpty

public static <T> Validation<List<T>> isNotEmpty(String errorCode)

validates that a list isn't empty. It mustn't be null and not empty.

Type Parameters:

T - the type of the list

Parameters:

errorCode - error code used incase of an violation

Returns:

new instance of list validation

isEmpty

public static <T> Validation<List<T>> isEmpty(String errorCode)

validates that a list is empty.

Type Parameters:

T - the type of the list

Parameters:

errorCode - error code used incase of an violation

Returns:

new instance of list validation

hasSize

public static <T> Validation<List<T>> hasSize(int size,
                                              String errorCode)

validates that a list has an expected size.

Type Parameters:

T - type of the list

Parameters:

size - the expected size

errorCode - error code used incase of an violation

Returns:

new instance of list validation

hasSize

public static <T> Validation<List<T>> hasSize(java.util.function.Supplier<Integer> size,
                                              String errorCode)

validates that a list has an expected size.

Type Parameters:

T - type of the list

Parameters:

size - the expected size

errorCode - error code used incase of an violation

Returns:

new instance of list validation

hasMinSize

public static <T> Validation<List<T>> hasMinSize(int size,
                                                 String errorCode)

validates that a list has an expected minimum size.

Type Parameters:

T - type of the list

Parameters:

size - the expected minimum size

errorCode - error code used incase of an violation

Returns:

new instance of list validation

hasMinSize

public static <T> Validation<List<T>> hasMinSize(java.util.function.Supplier<Integer> size,
                                                 String errorCode)

validates that a list has an expected minimum size.

Type Parameters:

T - type of the list

Parameters:

size - the expected minimum size

errorCode - error code used incase of an violation

Returns:

new instance of list validation

hasMaxSize

public static <T> Validation<List<T>> hasMaxSize(int size,
                                                 String errorCode)

validates that a list has an expected maximum size.

Type Parameters:

T - type of the list

Parameters:

size - the expected maximum size

errorCode - error code used incase of an violation

Returns:

new instance of list validation

hasMaxSize

public static <T> Validation<List<T>> hasMaxSize(java.util.function.Supplier<Integer> size,
                                                 String errorCode)

validates that a list has an expected maximum size.

Type Parameters:

T - type of the list

Parameters:

size - the expected maximum size

errorCode - error code used incase of an violation

Returns:

new instance of list validation

onProperty

public static <T,E> Validation<List<T>> onProperty(java.util.function.Function<T,E> function,
                                                   Validation<List<E>> validation)

validation for a property of the list entries.

Type Parameters:

T - type of the list

E - type of the validated property of the list entry

Parameters:

function - mapper for the property of the list entries(like in streams)

validation - validation for the properties of the list. All validations for the property should be put here

Returns:

new instance of a list validation

forType

public static <T> Validation<List<T>> forType(Class<T> listType,
                                              Validation<List<T>> validation)

sadly this method is needed if you want to start with general validations on lists, like the notEmpty, and afterwards the entries should be validated by a property. If you would just start with isNotEmpty(String) ()}, a Validation for List of type Object is returned, instead of the type of the list entries.

Type Parameters:

T - the type of the validated list

Parameters:

listType - the generic typ of the list, which will be validated

validation - the validation which should be invoked for the validated list.

Returns:

new instance of a list validation