1 package com.inigoserrano.isvalidator.check;
2
3 import com.inigoserrano.isvalidator.checkExceptions.CheckException;
4
5 /***
6 * This Interface represents the signature of the methods that must implement
7 * a Check. One Check represent a restriction of one data. For example one
8 * String can be a data.
9 * If we want to check if that email is really an email then we must apply a
10 * Check (EmailCheck)
11 * If we want to check also if the long of the email is less than 100 we can
12 * apply another Check.
13 *
14 * <br>Itīs important to say than ONE Data can have MULTIPLE Check and
15 * ONE INSTANCE of a Check is for ONLY ONE data
16 *
17 * @license@
18 *
19 * @version @version@
20 * @author @author@
21 **/
22 public interface Check {
23 /***
24 * This method verify the Check and return true or false if the data
25 * match or no
26 *
27 * @return true if the data match the check, else false
28 * @throws CheckException if the data dosenī t mach and the flag is true
29 * @throws InternalCheckException if an error ocurs
30 **/
31 boolean check() throws InternalCheckException, CheckException;
32
33 /***
34 * This method return true if the Check has been checked, and
35 * false otherwise
36 *
37 * @return true if checked, false if no
38 **/
39 boolean isChecked();
40
41 /***
42 * This method return the value of return of the method check,
43 * it is usefully to check the state twice without checking it again
44 *
45 * @return true if the data match the constraint or false if dosenīt
46 **/
47 boolean match();
48 }
This page was automatically generated by Maven