IValidator.java revision a0bccbddc52575255c5ce19c9d2c96d9639d26ca 
1/*
2 * Copyright (C) 2010 The Android Open Source Project
3 *
4 * Licensed under the Eclipse Public License, Version 1.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.eclipse.org/org/documents/epl-v10.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package com.android.ide.common.api;
18
19/**
20 * An IValidator can validate strings and return custom messages if validation
21 * fails.
22 * <p>
23 * <b>NOTE: This is not a public or final API; if you rely on this be prepared
24 * to adjust your code for the next tools release.</b>
25 * </p>
26 */
27public interface IValidator {
28    /**
29     * Validates the given input string, and return null if the text is valid,
30     * and otherwise return a description for why the text is invalid. Returning
31     * an empty String ("") is acceptable (but should only be done when it is
32     * obvious to the user why the String is not valid.)
33     *
34     * @param text The input string to be validated
35     * @return Null if the text is valid, and otherwise a description (possibly
36     *         empty) for why the text is not valid.
37     */
38    String validate(String text);
39}
40