diff org.eclipse.core.databinding/src/org/eclipse/core/databinding/validation/IValidator.d @ 78:0a55d2d5a946

Added file for databinding
author Frank Benoit <benoit@tionex.de>
date Tue, 14 Apr 2009 11:35:29 +0200
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/org.eclipse.core.databinding/src/org/eclipse/core/databinding/validation/IValidator.d	Tue Apr 14 11:35:29 2009 +0200
@@ -0,0 +1,39 @@
+/*******************************************************************************
+ * Copyright (c) 2005, 2007 IBM Corporation and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *     IBM Corporation - initial API and implementation
+ *******************************************************************************/
+module org.eclipse.core.databinding.validation.IValidator;
+
+import java.lang.all;
+
+import org.eclipse.core.runtime.IStatus;
+
+/**
+ * A validator. This validator is responsible for determining if a given value
+ * is valid. Validators can be used on target or model values. For example, a
+ * String2IntValidator would only accept source Strings that can successfully be
+ * converted to an integer value, and a PositiveIntegerValidator would only
+ * accept positive integers.
+ * 
+ * @since 1.0
+ * 
+ */
+public interface IValidator {
+
+    /**
+     * Determines if the given value is valid.
+     * 
+     * @param value
+     *            the value to validate
+     * @return a status object indicating whether the validation succeeded
+     *         {@link IStatus#isOK()} or not. Never null.
+     */
+    public IStatus validate(Object value);
+    
+}