சரிபார் - sari-paar (Tamil for "to check", "verify" or "validate")
Android Saripaar is a simple, yet powerful rule-based UI form validation library for Android. It is the SIMPLEST and FEATURE-RICH validation library available for Android.
- Built on top of Apache Commons Validator, a validation framework with proven track record on the web, desktop and mobile platforms.
- Declarative style validation using Annotations.
- Extensible, now allows Custom Annotations.
- Synchronous and Asynchronous validations, you don't have to worry about threading.
- Supports both BURST and IMMEDIATE modes.
- Works with Stock Android Widgets, no custom view dependencies.
- Quick to setup, just download the jar and include it in your
libs
project folder. - Isolates validation logic using rules.
- Compatible with other annotation frameworks such as ButterKnife, AndroidAnnotations, RoboGuice, etc.,
Step 1 - Annotate your widgets using Saripaar Annotations
@NotEmpty
@Email
private EditText emailEditText;
@Password
@Size(min = 6, message = "Enter at least 6 characters.")
private EditText passwordEditText;
@ConfirmPassword
private EditText confirmPasswordEditText;
@Checked(message = "You must agree to the terms.")
private CheckBox iAgreeCheckBox;
The annotations are self-explanatory. The @Order
annotation is required ONLY when performing ordered validations using
Validator.validateTill(View)
and Validator.validateBefore(View)
or in IMMEDIATE
mode.
Step 2 - Instantiate a new Validator
public void onCreate() {
super.onCreate();
// Code…
validator = new Validator(this);
validator.setValidationListener(this);
// More code…
}
You will need a Validator
and a ValidationListener
for receiving callbacks on validation events.
Step 3 - Implement a ValidationListener
public class RegistrationActivity implements ValidationListener {
public void onValidationSucceeded() {
Toast.makeText(this, "Yay! we got it right!", Toast.LENGTH_SHORT).show();
}
public void onValidationFailed(List<ValidationError> errors) {
for (ValidationError error : errors) {
// Do anything you want :)
}
}
}
onValidationSucceeded()
- Called when all your views pass all validations.onValidationFailed(List<ValidationError> errors)
- Called when there are validation error(s).
Step 4 - Validate
registerButton.setOnClickListener(new OnClickListener() {
public void onClick(View v) {
validator.validate();
}
});
The Validator.validate()
call runs the validations and returns the result via appropriate callbacks on the ValidationListener
. You can run validations on a background AsyncTask
by calling the Validator.validate(true)
method.
<dependency>
<groupId>com.mobsandgeeks</groupId>
<artifactId>android-saripaar</artifactId>
<version>2.0-SNAPSHOT</version>
</dependency>
dependencies {
compile 'com.mobsandgeeks:android-saripaar:2.0-SNAPSHOT'
}
In your {project_base}/build.gradle
file, include the following.
allprojects {
repositories {
mavenCentral()
maven {
url "https://oss.sonatype.org/content/repositories/snapshots/"
}
}
}
Please visit the wiki for a complete guide on Android Saripaar.
Copyright 2012 - 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.
Saripaar Logo © 2013 - 2014, Mobs & Geeks.