update Constraint java docs and annotations
This commit is contained in:
parent
78d076768e
commit
99db68d75c
1 changed files with 44 additions and 5 deletions
|
@ -43,6 +43,8 @@ public final class Constraint {
|
||||||
/**
|
/**
|
||||||
* NotNull annotation is using to check that value is not null before storing it
|
* NotNull annotation is using to check that value is not null before storing it
|
||||||
*
|
*
|
||||||
|
* Applicable to use in any @java.lang.Object
|
||||||
|
*
|
||||||
* It does not check on selects and data retrieval operations
|
* It does not check on selects and data retrieval operations
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
@ -57,6 +59,8 @@ public final class Constraint {
|
||||||
/**
|
/**
|
||||||
* NotEmptyText annotation is using to check that value has text before storing it
|
* NotEmptyText annotation is using to check that value has text before storing it
|
||||||
*
|
*
|
||||||
|
* Can be used only for @java.lang.CharSequence
|
||||||
|
*
|
||||||
* It does not check on selects and data retrieval operations
|
* It does not check on selects and data retrieval operations
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
@ -71,6 +75,8 @@ public final class Constraint {
|
||||||
/**
|
/**
|
||||||
* Email annotation is using to check that value has a valid email before storing it
|
* Email annotation is using to check that value has a valid email before storing it
|
||||||
*
|
*
|
||||||
|
* Can be used only for @java.lang.CharSequence
|
||||||
|
*
|
||||||
* It does not check on selects and data retrieval operations
|
* It does not check on selects and data retrieval operations
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
@ -85,6 +91,8 @@ public final class Constraint {
|
||||||
/**
|
/**
|
||||||
* Number annotation is using to check that all letters in value are digits before storing it
|
* Number annotation is using to check that all letters in value are digits before storing it
|
||||||
*
|
*
|
||||||
|
* Can be used only for @java.lang.CharSequence
|
||||||
|
*
|
||||||
* It does not check on selects and data retrieval operations
|
* It does not check on selects and data retrieval operations
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
@ -100,6 +108,8 @@ public final class Constraint {
|
||||||
/**
|
/**
|
||||||
* Alphabet annotation is using to check that all letters in value are in specific alphabet before storing it
|
* Alphabet annotation is using to check that all letters in value are in specific alphabet before storing it
|
||||||
*
|
*
|
||||||
|
* Can be used only for @java.lang.CharSequence
|
||||||
|
*
|
||||||
* It does not check on selects and data retrieval operations
|
* It does not check on selects and data retrieval operations
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
@ -109,13 +119,21 @@ public final class Constraint {
|
||||||
@Target(value = { ElementType.METHOD, ElementType.ANNOTATION_TYPE })
|
@Target(value = { ElementType.METHOD, ElementType.ANNOTATION_TYPE })
|
||||||
public @interface Alphabet {
|
public @interface Alphabet {
|
||||||
|
|
||||||
char[] value();
|
/**
|
||||||
|
* Defines alphabet that will be used to check value
|
||||||
|
*
|
||||||
|
* @return alphabet characters in the string
|
||||||
|
*/
|
||||||
|
|
||||||
|
String value();
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Length annotation is using to ensure that value has exact length before storing it
|
* Length annotation is using to ensure that value has exact length before storing it
|
||||||
*
|
*
|
||||||
|
* Can be used for @java.lang.CharSequence, @ByteBuffer and byte[]
|
||||||
|
*
|
||||||
* It does not have effect on selects and data retrieval operations
|
* It does not have effect on selects and data retrieval operations
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
@ -132,6 +150,8 @@ public final class Constraint {
|
||||||
/**
|
/**
|
||||||
* MaxLength annotation is using to ensure that value has length less or equal to some threshold before storing it
|
* MaxLength annotation is using to ensure that value has length less or equal to some threshold before storing it
|
||||||
*
|
*
|
||||||
|
* Can be used for @java.lang.CharSequence, @ByteBuffer and byte[]
|
||||||
|
*
|
||||||
* It does not have effect on selects and data retrieval operations
|
* It does not have effect on selects and data retrieval operations
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
@ -148,6 +168,8 @@ public final class Constraint {
|
||||||
/**
|
/**
|
||||||
* MinLength annotation is using to ensure that value has length greater or equal to some threshold before storing it
|
* MinLength annotation is using to ensure that value has length greater or equal to some threshold before storing it
|
||||||
*
|
*
|
||||||
|
* Can be used for @java.lang.CharSequence, @ByteBuffer and byte[]
|
||||||
|
*
|
||||||
* It does not have effect on selects and data retrieval operations
|
* It does not have effect on selects and data retrieval operations
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
@ -164,6 +186,8 @@ public final class Constraint {
|
||||||
/**
|
/**
|
||||||
* LowerCase annotation is using to ensure that value is in lower case before storing it
|
* LowerCase annotation is using to ensure that value is in lower case before storing it
|
||||||
*
|
*
|
||||||
|
* Can be used only for @java.lang.CharSequence
|
||||||
|
*
|
||||||
* It does not have effect on selects and data retrieval operations
|
* It does not have effect on selects and data retrieval operations
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
@ -178,6 +202,8 @@ public final class Constraint {
|
||||||
/**
|
/**
|
||||||
* UpperCase annotation is using to ensure that value is in upper case before storing it
|
* UpperCase annotation is using to ensure that value is in upper case before storing it
|
||||||
*
|
*
|
||||||
|
* Can be used only for @java.lang.CharSequence
|
||||||
|
*
|
||||||
* It does not have effect on selects and data retrieval operations
|
* It does not have effect on selects and data retrieval operations
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
@ -192,6 +218,8 @@ public final class Constraint {
|
||||||
/**
|
/**
|
||||||
* Pattern annotation is LowerCase annotation is using to ensure that value is upper case before storing it
|
* Pattern annotation is LowerCase annotation is using to ensure that value is upper case before storing it
|
||||||
*
|
*
|
||||||
|
* Can be used only for @java.lang.CharSequence
|
||||||
|
*
|
||||||
* It does not have effect on selects and data retrieval operations
|
* It does not have effect on selects and data retrieval operations
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
@ -204,7 +232,7 @@ public final class Constraint {
|
||||||
/**
|
/**
|
||||||
* User defined regex expression to check match of the value
|
* User defined regex expression to check match of the value
|
||||||
*
|
*
|
||||||
* @return Regex pattern
|
* @return Java regex pattern
|
||||||
*/
|
*/
|
||||||
|
|
||||||
String value();
|
String value();
|
||||||
|
@ -214,6 +242,8 @@ public final class Constraint {
|
||||||
/**
|
/**
|
||||||
* Custom annotation is using special implementation to check value before storing it
|
* Custom annotation is using special implementation to check value before storing it
|
||||||
*
|
*
|
||||||
|
* Applicable to use in any @java.lang.Object
|
||||||
|
*
|
||||||
* It does not have effect on selects and data retrieval operations
|
* It does not have effect on selects and data retrieval operations
|
||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
|
@ -224,14 +254,23 @@ public final class Constraint {
|
||||||
public @interface Custom {
|
public @interface Custom {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Defines class name of the custom implementation of the checker.
|
* Defines value that will be passed to the checker
|
||||||
* Class must implement special interface for this and be thread-safe and do not relay that it will be a singleton.
|
|
||||||
*
|
*
|
||||||
* @return className of the custom implementation
|
* @return value in the string form, can be anything that checker implemented in className understands
|
||||||
*/
|
*/
|
||||||
|
|
||||||
String value();
|
String value();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Defines class name of the custom implementation of the checker.
|
||||||
|
* Class must implement special interface for this and be thread-safe and do not relay that it will be a singleton.
|
||||||
|
*
|
||||||
|
*
|
||||||
|
* @return className of the custom implementation
|
||||||
|
*/
|
||||||
|
|
||||||
|
String className();
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue