/*
* Copyright (C) 2014 Mobs & Geeks
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the
* License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied. See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.mobsandgeeks.saripaar;
import android.app.Activity;
import android.app.Fragment;
import android.content.Context;
import android.os.AsyncTask;
import android.os.Build;
import android.os.Handler;
import android.os.Looper;
import android.util.Pair;
import android.view.View;
import android.widget.CheckBox;
import android.widget.RadioButton;
import android.widget.RadioGroup;
import android.widget.Spinner;
import com.mobsandgeeks.saripaar.adapter.CheckBoxBooleanAdapter;
import com.mobsandgeeks.saripaar.adapter.RadioButtonBooleanAdapter;
import com.mobsandgeeks.saripaar.adapter.RadioGroupBooleanAdapter;
import com.mobsandgeeks.saripaar.adapter.SpinnerIndexAdapter;
import com.mobsandgeeks.saripaar.adapter.ViewDataAdapter;
import com.mobsandgeeks.saripaar.annotation.AssertFalse;
import com.mobsandgeeks.saripaar.annotation.AssertTrue;
import com.mobsandgeeks.saripaar.annotation.Checked;
import com.mobsandgeeks.saripaar.annotation.ConfirmEmail;
import com.mobsandgeeks.saripaar.annotation.ConfirmPassword;
import com.mobsandgeeks.saripaar.annotation.CreditCard;
import com.mobsandgeeks.saripaar.annotation.DecimalMax;
import com.mobsandgeeks.saripaar.annotation.DecimalMin;
import com.mobsandgeeks.saripaar.annotation.Digits;
import com.mobsandgeeks.saripaar.annotation.Domain;
import com.mobsandgeeks.saripaar.annotation.Email;
import com.mobsandgeeks.saripaar.annotation.Future;
import com.mobsandgeeks.saripaar.annotation.IpAddress;
import com.mobsandgeeks.saripaar.annotation.IsPhone;
import com.mobsandgeeks.saripaar.annotation.Isbn;
import com.mobsandgeeks.saripaar.annotation.Length;
import com.mobsandgeeks.saripaar.annotation.Max;
import com.mobsandgeeks.saripaar.annotation.Min;
import com.mobsandgeeks.saripaar.annotation.NotEmpty;
import com.mobsandgeeks.saripaar.annotation.Order;
import com.mobsandgeeks.saripaar.annotation.Password;
import com.mobsandgeeks.saripaar.annotation.Past;
import com.mobsandgeeks.saripaar.annotation.Pattern;
import com.mobsandgeeks.saripaar.annotation.Select;
import com.mobsandgeeks.saripaar.annotation.Url;
import com.mobsandgeeks.saripaar.annotation.ValidateUsing;
import com.mobsandgeeks.saripaar.exception.ConversionException;
import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* The {@link com.mobsandgeeks.saripaar.Validator} takes care of validating the
* {@link android.view.View}s in the given controller instance. Usually, an
* {@link android.app.Activity} or a {@link android.app.Fragment}. However, it can also be used
* with other controller classes that contain references to {@link android.view.View} objects.
* <p>
* The {@link com.mobsandgeeks.saripaar.Validator} is capable of performing validations in two
* modes,
* <ol>
* <li>{@link Mode#BURST}, where all the views are validated and all errors are reported
* via the callback at once. Fields need not be ordered using the
* {@link com.mobsandgeeks.saripaar.annotation.Order} annotation in {@code BURST} mode.
* </li>
* <li>{@link Mode#IMMEDIATE}, in which the validation stops and the error is reported as soon
* as a {@link com.mobsandgeeks.saripaar.Rule} fails. To use this mode, the fields SHOULD
* BE ordered using the {@link com.mobsandgeeks.saripaar.annotation.Order} annotation.
* </li>
* </ol>
* <p>
* There are three flavors of the {@code validate()} method.
* <ol>
* <li>{@link #validate()}, no frills regular validation that validates all
* {@link android.view.View}s.
* </li>
* <li>{@link #validateTill(android.view.View)}, validates all {@link android.view.View}s till
* the one that is specified.
* </li>
* <li>{@link #validateBefore(android.view.View)}, validates all {@link android.view.View}s
* before the specified {@link android.view.View}.
* </li>
* </ol>
* <p>
* It is imperative that the fields are ordered while making the
* {@link #validateTill(android.view.View)} and {@link #validateBefore(android.view.View)} method
* calls.
* <p>
* The {@link com.mobsandgeeks.saripaar.Validator} requires a
* {@link com.mobsandgeeks.saripaar.Validator.ValidationListener} that reports the outcome of the
* validation.
* <ul>
* <li> {@link com.mobsandgeeks.saripaar.Validator.ValidationListener#onValidationSucceeded()}
* is called if all {@link com.mobsandgeeks.saripaar.Rule}s pass.
* </li>
* <li>
* The {@link Validator.ValidationListener#onValidationFailed(java.util.List)}
* callback reports errors caused by failures. In {@link Mode#IMMEDIATE} this callback will
* contain just one instance of the {@link com.mobsandgeeks.saripaar.ValidationError}
* object.
* </li>
* </ul>
*
* @author Ragunath Jawahar {@literal <rj@mobsandgeeks.com>}
* @since 1.0
*/
@SuppressWarnings("unchecked")
public class Validator {
// Entries are registered inside a static block (Placed at the end of source)
private static final Registry SARIPAAR_REGISTRY = new Registry();
// Holds adapter entries that are mapped to corresponding views.
private final
Map<Class<? extends View>, HashMap<Class<?>, ViewDataAdapter>> mRegisteredAdaptersMap =
new HashMap<Class<? extends View>, HashMap<Class<?>, ViewDataAdapter>>();
// Attributes
private Object mController;
private Mode mValidationMode;
private ValidationContext mValidationContext;
private Map<View, ArrayList<Pair<Rule, ViewDataAdapter>>> mViewRulesMap;
private boolean mOrderedFields;
private SequenceComparator mSequenceComparator;
private ViewValidatedAction mViewValidatedAction;
private Handler mViewValidatedActionHandler;
private ValidationListener mValidationListener;
private AsyncValidationTask mAsyncValidationTask;
/**
* Constructor.
*
* @param controller The class containing {@link android.view.View}s to be validated. Usually,
* an {@link android.app.Activity} or a {@link android.app.Fragment}.
*/
public Validator(final Object controller) {
assertNotNull(controller, "controller");
mController = controller;
mValidationMode = Mode.BURST;
mSequenceComparator = new SequenceComparator();
mViewValidatedAction = new DefaultViewValidatedAction();
// Instantiate a ValidationContext
if (controller instanceof Activity) {
mValidationContext = new ValidationContext((Activity) controller);
} else if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.HONEYCOMB
&& controller instanceof Fragment) {
Activity activity = ((Fragment) controller).getActivity();
mValidationContext = new ValidationContext(activity);
}
// Else, lazy init ValidationContext in #getRuleAdapterPair(Annotation, Field)
// or void #put(VIEW, QuickRule<VIEW>) by obtaining a Context from one of the
// View instances.
}
/**
* A convenience method for registering {@link com.mobsandgeeks.saripaar.Rule} annotations that
* act on {@link android.widget.TextView} and it's children, the most notable one being
* {@link android.widget.EditText}. Register custom annotations for
* {@link android.widget.TextView}s that validates {@link java.lang.Double},
* {@link java.lang.Float}, {@link java.lang.Integer} and {@link java.lang.String} types.
* <p>
* For registering rule annotations for other view types see,
* {@link #registerAdapter(Class, com.mobsandgeeks.saripaar.adapter.ViewDataAdapter)}.
*
* @param ruleAnnotation A rule {@link java.lang.annotation.Annotation}.
*/
public static void registerAnnotation(final Class<? extends Annotation> ruleAnnotation) {
SARIPAAR_REGISTRY.register(ruleAnnotation);
}
/**
* An elaborate method for registering custom rule annotations.
*
* @param annotation The annotation that you want to register.
* @param viewType The {@link android.view.View} type.
* @param viewDataAdapter An instance of the
* {@link com.mobsandgeeks.saripaar.adapter.ViewDataAdapter} for your
* {@link android.view.View}.
*
* @param <VIEW> The {@link android.view.View} for which the
* {@link java.lang.annotation.Annotation} and
* {@link com.mobsandgeeks.saripaar.adapter.ViewDataAdapter} is being registered.
*/
public static <VIEW extends View> void registerAnnotation(
final Class<? extends Annotation> annotation, final Class<VIEW> viewType,
final ViewDataAdapter<VIEW, ?> viewDataAdapter) {
ValidateUsing validateUsing = annotation.getAnnotation(ValidateUsing.class);
Class ruleDataType = Reflector.getRuleDataType(validateUsing);
SARIPAAR_REGISTRY.register(viewType, ruleDataType, viewDataAdapter, annotation);
}
/**
* Registers a {@link com.mobsandgeeks.saripaar.adapter.ViewDataAdapter} for the given
* {@link android.view.View}.
*
* @param viewType The {@link android.view.View} for which a
* {@link com.mobsandgeeks.saripaar.adapter.ViewDataAdapter} is being registered.
* @param viewDataAdapter A {@link com.mobsandgeeks.saripaar.adapter.ViewDataAdapter} instance.
*
* @param <VIEW> The {@link android.view.View} type.
* @param <DATA_TYPE> The {@link com.mobsandgeeks.saripaar.adapter.ViewDataAdapter} type.
*/
public <VIEW extends View, DATA_TYPE> void registerAdapter(
final Class<VIEW> viewType, final ViewDataAdapter<VIEW, DATA_TYPE> viewDataAdapter) {
assertNotNull(viewType, "viewType");
assertNotNull(viewDataAdapter, "viewDataAdapter");
HashMap<Class<?>, ViewDataAdapter> dataTypeAdapterMap = mRegisteredAdaptersMap.get(viewType);
if (dataTypeAdapterMap == null) {
dataTypeAdapterMap = new HashMap<Class<?>, ViewDataAdapter>();
mRegisteredAdaptersMap.put(viewType, dataTypeAdapterMap);
}
// Find adapter's data type
Method getDataMethod = Reflector.findGetDataMethod(viewDataAdapter.getClass());
Class<?> adapterDataType = getDataMethod.getReturnType();
dataTypeAdapterMap.put(adapterDataType, viewDataAdapter);
}
/**
* Set a {@link com.mobsandgeeks.saripaar.Validator.ValidationListener} to the
* {@link com.mobsandgeeks.saripaar.Validator}.
*
* @param validationListener A {@link com.mobsandgeeks.saripaar.Validator.ValidationListener}
* instance. null throws an {@link java.lang.IllegalArgumentException}.
*/
public void setValidationListener(final ValidationListener validationListener) {
assertNotNull(validationListener, "validationListener");
this.mValidationListener = validationListener;
}
/**
* Set a {@link com.mobsandgeeks.saripaar.Validator.ViewValidatedAction} to the
* {@link com.mobsandgeeks.saripaar.Validator}.
*
* @param viewValidatedAction A {@link com.mobsandgeeks.saripaar.Validator.ViewValidatedAction}
* instance.
*/
public void setViewValidatedAction(final ViewValidatedAction viewValidatedAction) {
this.mViewValidatedAction = viewValidatedAction;
}
/**
* Set the validation {@link com.mobsandgeeks.saripaar.Validator.Mode} for the current
* {@link com.mobsandgeeks.saripaar.Validator} instance.
*
* @param validationMode {@link Mode#BURST} or {@link Mode#IMMEDIATE}, null throws an
* {@link java.lang.IllegalArgumentException}.
*/
public void setValidationMode(final Mode validationMode) {
assertNotNull(validationMode, "validationMode");
this.mValidationMode = validationMode;
}
/**
* Gets the current {@link com.mobsandgeeks.saripaar.Validator.Mode}.
*
* @return The current validation mode of the {@link com.mobsandgeeks.saripaar.Validator}.
*/
public Mode getValidationMode() {
return mValidationMode;
}
/**
* Validates all {@link android.view.View}s with {@link com.mobsandgeeks.saripaar.Rule}s.
* When validating in {@link com.mobsandgeeks.saripaar.Validator.Mode#IMMEDIATE}, all
* {@link android.view.View} fields must be ordered using the
* {@link com.mobsandgeeks.saripaar.annotation.Order} annotation.
*/
public void validate() {
validate(false);
}
/**
* Validates all {@link android.view.View}s before the specified {@link android.view.View}
* parameter. {@link android.view.View} fields MUST be ordered using the
* {@link com.mobsandgeeks.saripaar.annotation.Order} annotation.
*
* @param view A {@link android.view.View}.
*/
public void validateBefore(final View view) {
validateBefore(view, false);
}
/**
* Validates all {@link android.view.View}s till the specified {@link android.view.View}
* parameter. {@link android.view.View} fields MUST be ordered using the
* {@link com.mobsandgeeks.saripaar.annotation.Order} annotation.
*
* @param view A {@link android.view.View}.
*/
public void validateTill(final View view) {
validateTill(view, false);
}
/**
* Validates all {@link android.view.View}s with {@link com.mobsandgeeks.saripaar.Rule}s.
* When validating in {@link com.mobsandgeeks.saripaar.Validator.Mode#IMMEDIATE}, all
* {@link android.view.View} fields must be ordered using the
* {@link com.mobsandgeeks.saripaar.annotation.Order} annotation. Asynchronous calls will cancel
* any pending or ongoing asynchronous validation and start a new one.
*
* @param async true if asynchronous, false otherwise.
*/
public void validate(final boolean async) {
createRulesSafelyAndLazily(false);
View lastView = getLastView();
if (Mode.BURST.equals(mValidationMode)) {
validateUnorderedFieldsWithCallbackTill(lastView, async);
} else if (Mode.IMMEDIATE.equals(mValidationMode)) {
String reasonSuffix = String.format("in %s mode.", Mode.IMMEDIATE.toString());
validateOrderedFieldsWithCallbackTill(lastView, reasonSuffix, async);
} else {
throw new RuntimeException("This should never happen!");
}
}
/**
* Validates all {@link android.view.View}s before the specified {@link android.view.View}
* parameter. {@link android.view.View} fields MUST be ordered using the
* {@link com.mobsandgeeks.saripaar.annotation.Order} annotation. Asynchronous calls will cancel
* any pending or ongoing asynchronous validation and start a new one.
*
* @param view A {@link android.view.View}.
* @param async true if asynchronous, false otherwise.
*/
public void validateBefore(final View view, final boolean async) {
createRulesSafelyAndLazily(false);
View previousView = getViewBefore(view);
validateOrderedFieldsWithCallbackTill(previousView, "when using 'validateBefore(View)'.",
async);
}
/**
* Validates all {@link android.view.View}s till the specified {@link android.view.View}
* parameter. {@link android.view.View} fields MUST be ordered using the
* {@link com.mobsandgeeks.saripaar.annotation.Order} annotation. Asynchronous calls will cancel
* any pending or ongoing asynchronous validation and start a new one.
*
* @param view A {@link android.view.View}.
* @param async true if asynchronous, false otherwise.
*/
public void validateTill(final View view, final boolean async) {
validateOrderedFieldsWithCallbackTill(view, "when using 'validateTill(View)'.", async);
}
/**
* Used to find if an asynchronous validation task is running. Useful only when you run the
* {@link com.mobsandgeeks.saripaar.Validator} in asynchronous mode.
*
* @return true if the asynchronous task is running, false otherwise.
*/
public boolean isValidating() {
return mAsyncValidationTask != null
&& mAsyncValidationTask.getStatus() != AsyncTask.Status.FINISHED;
}
/**
* Cancels a running asynchronous validation task.
*
* @return true if a running asynchronous task was cancelled, false otherwise.
*/
public boolean cancelAsync() {
boolean cancelled = false;
if (mAsyncValidationTask != null) {
cancelled = mAsyncValidationTask.cancel(true);
mAsyncValidationTask = null;
}
return cancelled;
}
/**
* Add one or more {@link com.mobsandgeeks.saripaar.QuickRule}s for a {@link android.view.View}.
*
* @param view A {@link android.view.View} for which
* {@link com.mobsandgeeks.saripaar.QuickRule}(s) are to be added.
* @param quickRules Varargs of {@link com.mobsandgeeks.saripaar.QuickRule}s.
*
* @param <VIEW> The {@link android.view.View} type for which the
* {@link com.mobsandgeeks.saripaar.QuickRule}s are being registered.
*/
public <VIEW extends View> void put(final VIEW view, final QuickRule<VIEW>... quickRules) {
assertNotNull(view, "view");
assertNotNull(quickRules, "quickRules");
if (quickRules.length == 0) {
throw new IllegalArgumentException("'quickRules' cannot be empty.");
}
if (mValidationContext == null) {
mValidationContext = new ValidationContext(view.getContext());
}
// Create rules
createRulesSafelyAndLazily(true);
// If all fields are ordered, then this field should be ordered too
if (mOrderedFields && !mViewRulesMap.containsKey(view)) {
String message = String.format("All fields are ordered, so this `%s` should be "
+ "ordered too, declare the view as a field and add the `@Order` "
+ "annotation.", view.getClass().getName());
throw new IllegalStateException(message);
}
// If there are no rules, create an empty list
ArrayList<Pair<Rule, ViewDataAdapter>> ruleAdapterPairs = mViewRulesMap.get(view);
ruleAdapterPairs = ruleAdapterPairs == null
? new ArrayList<Pair<Rule, ViewDataAdapter>>() : ruleAdapterPairs;
// Add the quick rule to existing rules
for (QuickRule quickRule : quickRules) {
if (quickRule != null) {
ruleAdapterPairs.add(new Pair(quickRule, null));
}
}
Collections.sort(ruleAdapterPairs, mSequenceComparator);
mViewRulesMap.put(view, ruleAdapterPairs);
}
/**
* Remove all {@link com.mobsandgeeks.saripaar.Rule}s for the given {@link android.view.View}.
*
* @param view The {@link android.view.View} whose rules should be removed.
*/
public void removeRules(final View view) {
assertNotNull(view, "view");
if (mViewRulesMap == null) {
createRulesSafelyAndLazily(false);
}
mViewRulesMap.remove(view);
}
static boolean isSaripaarAnnotation(final Class<? extends Annotation> annotation) {
return SARIPAAR_REGISTRY.getRegisteredAnnotations().contains(annotation);
}
/* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Private Methods
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
private static void assertNotNull(final Object object, final String argumentName) {
if (object == null) {
String message = String.format("'%s' cannot be null.", argumentName);
throw new IllegalArgumentException(message);
}
}
private void createRulesSafelyAndLazily(final boolean addingQuickRules) {
// Create rules lazily, because we don't have to worry about the order of
// instantiating the Validator.
if (mViewRulesMap == null) {
final List<Field> annotatedFields = getSaripaarAnnotatedFields(mController.getClass());
mViewRulesMap = createRules(annotatedFields);
mValidationContext.setViewRulesMap(mViewRulesMap);
}
if (!addingQuickRules && mViewRulesMap.size() == 0) {
String message = "No rules found. You must have at least one rule to validate. "
+ "If you are using custom annotations, make sure that you have registered "
+ "them using the 'Validator.register()' method.";
throw new IllegalStateException(message);
}
}
private List<Field> getSaripaarAnnotatedFields(final Class<?> controllerClass) {
Set<Class<? extends Annotation>> saripaarAnnotations =
SARIPAAR_REGISTRY.getRegisteredAnnotations();
List<Field> annotatedFields = new ArrayList<Field>();
List<Field> controllerViewFields = getControllerViewFields(controllerClass);
for (Field field : controllerViewFields) {
if (isSaripaarAnnotatedField(field, saripaarAnnotations)) {
annotatedFields.add(field);
}
}
// Sort
SaripaarFieldsComparator comparator = new SaripaarFieldsComparator();
Collections.sort(annotatedFields, comparator);
mOrderedFields = annotatedFields.size() == 1
? annotatedFields.get(0).getAnnotation(Order.class) != null
: annotatedFields.size() != 0 && comparator.areOrderedFields();
return annotatedFields;
}
private List<Field> getControllerViewFields(final Class<?> controllerClass) {
List<Field> controllerViewFields = new ArrayList<Field>();
// Fields declared in the controller
controllerViewFields.addAll(getViewFields(controllerClass));
// Inherited fields
Class<?> superClass = controllerClass.getSuperclass();
while (!superClass.equals(Object.class)) {
List<Field> viewFields = getViewFields(superClass);
if (viewFields.size() > 0) {
controllerViewFields.addAll(viewFields);
}
superClass = superClass.getSuperclass();
}
return controllerViewFields;
}
private List<Field> getViewFields(final Class<?> clazz) {
List<Field> viewFields = new ArrayList<Field>();
Field[] declaredFields = clazz.getDeclaredFields();
for (Field field : declaredFields) {
if (View.class.isAssignableFrom(field.getType())) {
viewFields.add(field);
}
}
return viewFields;
}
private boolean isSaripaarAnnotatedField(final Field field,
final Set<Class<? extends Annotation>> registeredAnnotations) {
boolean hasOrderAnnotation = field.getAnnotation(Order.class) != null;
boolean hasSaripaarAnnotation = false;
if (!hasOrderAnnotation) {
Annotation[] annotations = field.getAnnotations();
for (Annotation annotation : annotations) {
hasSaripaarAnnotation = registeredAnnotations.contains(annotation.annotationType());
if (hasSaripaarAnnotation) {
break;
}
}
}
return hasOrderAnnotation || hasSaripaarAnnotation;
}
private Map<View, ArrayList<Pair<Rule, ViewDataAdapter>>> createRules(
final List<Field> annotatedFields) {
final Map<View, ArrayList<Pair<Rule, ViewDataAdapter>>> viewRulesMap =
new LinkedHashMap<View, ArrayList<Pair<Rule, ViewDataAdapter>>>();
for (Field field : annotatedFields) {
final ArrayList<Pair<Rule, ViewDataAdapter>> ruleAdapterPairs =
new ArrayList<Pair<Rule, ViewDataAdapter>>();
final Annotation[] fieldAnnotations = field.getAnnotations();
for (Annotation fieldAnnotation : fieldAnnotations) {
if (isSaripaarAnnotation(fieldAnnotation.annotationType())) {
Pair<Rule, ViewDataAdapter> ruleAdapterPair =
getRuleAdapterPair(fieldAnnotation, field);
ruleAdapterPairs.add(ruleAdapterPair);
}
}
Collections.sort(ruleAdapterPairs, mSequenceComparator);
viewRulesMap.put(getView(field), ruleAdapterPairs);
}
return viewRulesMap;
}
private Pair<Rule, ViewDataAdapter> getRuleAdapterPair(final Annotation saripaarAnnotation,
final Field viewField) {
final Class<? extends Annotation> annotationType = saripaarAnnotation.annotationType();
final Class<?> viewFieldType = viewField.getType();
final Class<?> ruleDataType = Reflector.getRuleDataType(saripaarAnnotation);
final ViewDataAdapter dataAdapter = getDataAdapter(annotationType, viewFieldType,
ruleDataType);
// If no matching adapter is found, throw.
if (dataAdapter == null) {
String viewType = viewFieldType.getName();
String message = String.format(
"To use '%s' on '%s', register a '%s' that returns a '%s' from the '%s'.",
annotationType.getName(),
viewType,
ViewDataAdapter.class.getName(),
ruleDataType.getName(),
viewType);
throw new UnsupportedOperationException(message);
}
if (mValidationContext == null) {
mValidationContext = new ValidationContext(getContext(viewField));
}
final Class<? extends AnnotationRule> ruleType = getRuleType(saripaarAnnotation);
final AnnotationRule rule = Reflector.instantiateRule(ruleType,
saripaarAnnotation, mValidationContext);
return new Pair<Rule, ViewDataAdapter>(rule, dataAdapter);
}
private ViewDataAdapter getDataAdapter(final Class<? extends Annotation> annotationType,
final Class<?> viewFieldType, final Class<?> adapterDataType) {
// Get an adapter from the stock registry
ViewDataAdapter dataAdapter = SARIPAAR_REGISTRY.getDataAdapter(
annotationType, (Class) viewFieldType);
// If we are unable to find a Saripaar stock adapter, check the registered adapters
if (dataAdapter == null) {
HashMap<Class<?>, ViewDataAdapter> dataTypeAdapterMap =
mRegisteredAdaptersMap.get(viewFieldType);
dataAdapter = dataTypeAdapterMap != null
? dataTypeAdapterMap.get(adapterDataType)
: null;
}
return dataAdapter;
}
private Context getContext(final Field viewField) {
Context context = null;
try {
if (!viewField.isAccessible()) {
viewField.setAccessible(true);
}
View view = (View) viewField.get(mController);
context = view.getContext();
} catch (IllegalAccessException e) {
e.printStackTrace();
}
return context;
}
private Class<? extends AnnotationRule> getRuleType(final Annotation ruleAnnotation) {
ValidateUsing validateUsing = ruleAnnotation.annotationType()
.getAnnotation(ValidateUsing.class);
return validateUsing != null ? validateUsing.value() : null;
}
private View getView(final Field field) {
View view = null;
try {
field.setAccessible(true);
view = (View) field.get(mController);
if (view == null) {
String message = String.format("'%s %s' is null.",
field.getType().getSimpleName(), field.getName());
throw new IllegalStateException(message);
}
} catch (IllegalArgumentException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
}
return view;
}
private void validateUnorderedFieldsWithCallbackTill(final View view, final boolean async) {
validateFieldsWithCallbackTill(view, false, null, async);
}
private void validateOrderedFieldsWithCallbackTill(final View view, final String reasonSuffix,
final boolean async) {
validateFieldsWithCallbackTill(view, true, reasonSuffix, async);
}
private void validateFieldsWithCallbackTill(final View view, final boolean orderedFields,
final String reasonSuffix, final boolean async) {
createRulesSafelyAndLazily(false);
if (async) {
if (mAsyncValidationTask != null) {
mAsyncValidationTask.cancel(true);
}
mAsyncValidationTask = new AsyncValidationTask(view, orderedFields, reasonSuffix);
mAsyncValidationTask.execute((Void[]) null);
} else {
triggerValidationListenerCallback(validateTill(view, orderedFields, reasonSuffix));
}
}
private synchronized ValidationReport validateTill(final View view,
final boolean requiresOrderedRules, final String reasonSuffix) {
// Do we need ordered rules?
if (requiresOrderedRules) {
assertOrderedFields(mOrderedFields, reasonSuffix);
}
// Have we registered a validation listener?
assertNotNull(mValidationListener, "validationListener");
// Everything good. Bingo! validate ;)
return getValidationReport(view, mViewRulesMap, mValidationMode);
}
private void triggerValidationListenerCallback(final ValidationReport validationReport) {
final List<ValidationError> validationErrors = validationReport.errors;
if (validationErrors.size() == 0 && !validationReport.hasMoreErrors) {
mValidationListener.onValidationSucceeded();
} else {
mValidationListener.onValidationFailed(validationErrors);
}
}
private void assertOrderedFields(final boolean orderedRules, final String reasonSuffix) {
if (!orderedRules) {
String message = "Rules are unordered, all view fields should be ordered "
+ "using the '@Order' annotation " + reasonSuffix;
throw new IllegalStateException(message);
}
}
private ValidationReport getValidationReport(final View targetView,
final Map<View, ArrayList<Pair<Rule, ViewDataAdapter>>> viewRulesMap,
final Mode validationMode) {
final List<ValidationError> validationErrors = new ArrayList<ValidationError>();
final Set<View> views = viewRulesMap.keySet();
// Don't add errors for views that are placed after the specified view in validateTill()
boolean addErrorToReport = targetView != null;
// Does the form have more errors? Used in validateTill()
boolean hasMoreErrors = false;
validation:
for (View view : views) {
ArrayList<Pair<Rule, ViewDataAdapter>> ruleAdapterPairs = viewRulesMap.get(view);
int nRules = ruleAdapterPairs.size();
// Validate all the rules for the given view.
List<Rule> failedRules = null;
for (int i = 0; i < nRules; i++) {
// Validate only views that are visible and enabled
if (view.isShown() && view.isEnabled()) {
Pair<Rule, ViewDataAdapter> ruleAdapterPair = ruleAdapterPairs.get(i);
Rule failedRule = validateViewWithRule(
view, ruleAdapterPair.first, ruleAdapterPair.second);
boolean isLastRuleForView = nRules == i + 1;
if (failedRule != null) {
if (addErrorToReport) {
if (failedRules == null) {
failedRules = new ArrayList<Rule>();
validationErrors.add(new ValidationError(view, failedRules));
}
failedRules.add(failedRule);
} else {
hasMoreErrors = true;
}
if (Mode.IMMEDIATE.equals(validationMode) && isLastRuleForView) {
break validation;
}
}
// Don't add reports for subsequent views
if (view.equals(targetView) && isLastRuleForView) {
addErrorToReport = false;
}
}
}
// Callback if a view passes all rules
boolean viewPassedAllRules = (failedRules == null || failedRules.size() == 0)
&& !hasMoreErrors;
if (viewPassedAllRules && mViewValidatedAction != null) {
triggerViewValidatedCallback(mViewValidatedAction, view);
}
}
return new ValidationReport(validationErrors, hasMoreErrors);
}
private Rule validateViewWithRule(final View view, final Rule rule,
final ViewDataAdapter dataAdapter) {
boolean valid = false;
if (rule instanceof AnnotationRule) {
Object data;
try {
data = dataAdapter.getData(view);
valid = rule.isValid(data);
} catch (ConversionException e) {
valid = false;
e.printStackTrace();
}
} else if (rule instanceof QuickRule) {
valid = rule.isValid(view);
}
return valid ? null : rule;
}
private void triggerViewValidatedCallback(final ViewValidatedAction viewValidatedAction,
final View view) {
boolean isOnMainThread = Looper.myLooper() == Looper.getMainLooper();
if (isOnMainThread) {
viewValidatedAction.onAllRulesPassed(view);
} else {
runOnMainThread(new Runnable() {
@Override
public void run() {
viewValidatedAction.onAllRulesPassed(view);
}
});
}
}
private void runOnMainThread(final Runnable runnable) {
if (mViewValidatedActionHandler == null) {
mViewValidatedActionHandler = new Handler(Looper.getMainLooper());
}
mViewValidatedActionHandler.post(runnable);
}
private View getLastView() {
final Set<View> views = mViewRulesMap.keySet();
View lastView = null;
for (View view : views) {
lastView = view;
}
return lastView;
}
private View getViewBefore(final View view) {
ArrayList<View> views = new ArrayList<View>(mViewRulesMap.keySet());
final int nViews = views.size();
View currentView;
View previousView = null;
for (int i = 0; i < nViews; i++) {
currentView = views.get(i);
if (currentView == view) {
previousView = i > 0 ? views.get(i - 1) : null;
break;
}
}
return previousView;
}
/**
* Listener with callback methods that notifies the outcome of validation.
*
* @author Ragunath Jawahar {@literal <rj@mobsandgeeks.com>}
* @since 1.0
*/
public interface ValidationListener {
/**
* Called when all {@link com.mobsandgeeks.saripaar.Rule}s pass.
*/
void onValidationSucceeded();
/**
* Called when one or several {@link com.mobsandgeeks.saripaar.Rule}s fail.
*
* @param errors List containing references to the {@link android.view.View}s and
* {@link com.mobsandgeeks.saripaar.Rule}s that failed.
*/
void onValidationFailed(List<ValidationError> errors);
}
/**
* Interface that provides a callback when all {@link com.mobsandgeeks.saripaar.Rule}s
* associated with a {@link android.view.View} passes.
*
* @author Ragunath Jawahar {@literal <rj@mobsandgeeks.com>}
* @since 2.0
*/
public interface ViewValidatedAction {
/**
* Called when all rules associated with the {@link android.view.View} passes.
*
* @param view The {@link android.view.View} that has passed validation.
*/
void onAllRulesPassed(View view);
}
/**
* Validation mode.
*
* @author Ragunath Jawahar {@literal <rj@mobsandgeeks.com>}
* @since 2.0
*/
public enum Mode {
/**
* BURST mode will validate all rules in all views before calling the
* {@link Validator.ValidationListener#onValidationFailed(java.util.List)}
* callback. Ordering and sequencing is optional.
*/
BURST,
/**
* IMMEDIATE mode will stop the validation after validating all the rules
* of the first failing view. Requires ordered rules, sequencing is optional.
*/
IMMEDIATE
}
static class ValidationReport {
List<ValidationError> errors;
boolean hasMoreErrors;
ValidationReport(final List<ValidationError> errors, final boolean hasMoreErrors) {
this.errors = errors;
this.hasMoreErrors = hasMoreErrors;
}
}
class AsyncValidationTask extends AsyncTask<Void, Void, ValidationReport> {
private View mView;
private boolean mOrderedRules;
private String mReasonSuffix;
public AsyncValidationTask(final View view, final boolean orderedRules,
final String reasonSuffix) {
this.mView = view;
this.mOrderedRules = orderedRules;
this.mReasonSuffix = reasonSuffix;
}
@Override
protected ValidationReport doInBackground(final Void... params) {
return validateTill(mView, mOrderedRules, mReasonSuffix);
}
@Override
protected void onPostExecute(final ValidationReport validationReport) {
triggerValidationListenerCallback(validationReport);
}
}
static {
// CheckBoxBooleanAdapter
SARIPAAR_REGISTRY.register(CheckBox.class, Boolean.class,
new CheckBoxBooleanAdapter(),
AssertFalse.class, AssertTrue.class, Checked.class);
// RadioGroupBooleanAdapter
SARIPAAR_REGISTRY.register(RadioGroup.class, Boolean.class,
new RadioGroupBooleanAdapter(),
Checked.class);
// RadioButtonBooleanAdapter
SARIPAAR_REGISTRY.register(RadioButton.class, Boolean.class,
new RadioButtonBooleanAdapter(),
AssertFalse.class, AssertTrue.class, Checked.class);
// SpinnerIndexAdapter
SARIPAAR_REGISTRY.register(Spinner.class, Integer.class,
new SpinnerIndexAdapter(),
Select.class);
// TextViewDoubleAdapter
SARIPAAR_REGISTRY.register(DecimalMax.class, DecimalMin.class);
// TextViewIntegerAdapter
SARIPAAR_REGISTRY.register(Max.class, Min.class);
// TextViewStringAdapter
SARIPAAR_REGISTRY.register(
ConfirmEmail.class, ConfirmPassword.class, CreditCard.class,
Digits.class, Domain.class, Email.class, Future.class,
IpAddress.class, Isbn.class, Length.class, NotEmpty.class,
Password.class, Past.class, Pattern.class, Url.class, IsPhone.class);
}
}