diff org.eclipse.core.databinding/src/org/eclipse/core/databinding/conversion/IConverter.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/conversion/IConverter.d	Tue Apr 14 11:35:29 2009 +0200
@@ -0,0 +1,55 @@
+/*******************************************************************************
+ * Copyright (c) 2005, 2008 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.conversion.IConverter;
+
+import java.lang.all;
+
+/**
+ * A one-way converter.
+ * 
+ * @noextend This interface is not intended to be extended by clients.
+ * @noimplement This interface is not intended to be implemented by clients.
+ *              Clients should subclass {@link Converter}.
+ * 
+ * @since 1.0
+ * 
+ */
+public interface IConverter {
+
+    /**
+     * Returns the type whose instances can be converted by this converter. The
+     * return type is Object rather than Class to optionally support richer type
+     * systems than the one provided by Java reflection.
+     * 
+     * @return the type whose instances can be converted, or null if this
+     *         converter is untyped
+     */
+    public Object getFromType();
+
+    /**
+     * Returns the type to which this converter can convert. The return type is
+     * Object rather than Class to optionally support richer type systems than
+     * the one provided by Java reflection.
+     * 
+     * @return the type to which this converter can convert, or null if this
+     *         converter is untyped
+     */
+    public Object getToType();
+
+    /**
+     * Returns the result of the conversion of the given object.
+     * 
+     * @param fromObject
+     *            the object to convert, of type {@link #getFromType()}
+     * @return the converted object, of type {@link #getToType()}
+     */
+    public Object convert(Object fromObject);
+}