DroidMVVMValidator
Simple and light library to do validate observable fields with MVVM for android
Usage
Each ValidatedObservableField work like ObservableField, but it have 3 observables properties:
- value - contains the value of type T
- valid - boolean true if ALL Rules are valid
- errorMessage - contains NULL or errorMessage from first invalid Rule
Rules are validated one by one (the order is important), the first invalid Rule will break the chain and set errorMessage. Rules are validated onPropertyChange. You can create your own rules using Rule interface. You can use single Rule or many by RuleCommand.
public ValidatedObservableField<String> userName = new ValidatedObservableField<>("",
new RuleCommand.Builder<String>()
.withRule(new RegexRule("[a-z]+", "Only small letters")) // THE ORDER IS IMPORTANT!
.withRule(new MinimumLengthRule(3, "Three or more characters"))
.withRule(new MaximumLengthRule(12, "No more then twelve characters"))
.build());
or using lambdas:
public ValidatedObservableField<String> userName = new ValidatedObservableField<>("",
new RuleCommand.Builder<String>()
.withRule(s -> s != null && s.matches("[\\S]+"), "Whitespace characters not allowed") // THE ORDER IS IMPORTANT!
.withRule(s -> s != null && s.length() >= 3, "Three or more characters")
.withRule(s -> s != null && s.length() <= 12, "No more then twelve characters")
.build());
<android.support.design.widget.TextInputLayout
app:setError="@{
viewModel.userName.errorMessage
}
">
<android.support.design.widget.TextInputEditText
android:text="@={
viewModel.userName.value
}
"/>
</android.support.design.widget.TextInputLayout>
<Button
android:visibility="@{
viewModel.userName.valid ? View.VISIBLE : View.GONE
}
"/>Download
You can depend on the library through Gradle:
repositories {
jcenter()
}
dataBinding {
enabled = true
}
dependencies {
compile 'pl.com.mmotak.validator:droid-mvvm-validator:1.0.2'
}
Changelog
See CHANGELOG.md file.
License
Copyright 2017 Maciej Motak 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.