diff org.eclipse.core.commands/src/org/eclipse/core/internal/commands/util/Util.d @ 12:bc29606a740c

Added dwt-addons in original directory structure of eclipse.org
author Frank Benoit <benoit@tionex.de>
date Sat, 14 Mar 2009 18:23:29 +0100
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/org.eclipse.core.commands/src/org/eclipse/core/internal/commands/util/Util.d	Sat Mar 14 18:23:29 2009 +0100
@@ -0,0 +1,395 @@
+/*******************************************************************************
+ * Copyright (c) 2000, 2006 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
+ * Port to the D programming language:
+ *     Frank Benoit <benoit@tionex.de>
+ *******************************************************************************/
+
+module org.eclipse.core.internal.commands.util.Util;
+
+import java.lang.all;
+
+// import java.util.Collections;
+// import java.util.HashMap;
+// import java.util.HashSet;
+// import java.util.Iterator;
+// import java.util.Map;
+// import java.util.Set;
+// import java.util.SortedMap;
+// import java.util.SortedSet;
+// import java.util.TreeMap;
+// import java.util.TreeSet;
+
+/**
+ * A class providing utility functions for the commands plug-in.
+ *
+ * @since 3.1
+ */
+public final class Util {
+/++
+    /**
+     * A shared, unmodifiable, empty, sorted map. This value is guaranteed to
+     * always be the same.
+     */
+    public const static SortedMap EMPTY_SORTED_MAP = Collections
+            .unmodifiableSortedMap(new TreeMap());
+
+    /**
+     * A shared, unmodifiable, empty, sorted set. This value is guaranteed to
+     * always be the same.
+     */
+    public final static SortedSet EMPTY_SORTED_SET = Collections
+            .unmodifiableSortedSet(new TreeSet());
+++/
+    /**
+     * A shared, zero-length string -- for avoiding non-externalized string
+     * tags. This value is guaranteed to always be the same.
+     */
+    public final static String ZERO_LENGTH_STRING = "\0"[ 0 .. 0 ]; //$NON-NLS-1$
+/++
+
+    /**
+     * Asserts the the given object is an instance of the given class --
+     * optionally allowing the object to be <code>null</code>.
+     *
+     * @param object
+     *            The object for which the type should be checked.
+     * @param c
+     *            The class that the object must be; fails if the class is
+     *            <code>null</code>.
+     * @param allowNull
+     *            Whether the object being <code>null</code> will not cause a
+     *            failure.
+     */
+    public static final void assertInstance(final Object object, final Class c,
+            final bool allowNull) {
+        if (object is null && allowNull) {
+            return;
+        }
+
+        if (object is null || c is null) {
+            throw new NullPointerException();
+        } else if (!c.isInstance(object)) {
+            throw new IllegalArgumentException();
+        }
+    }
+++/
+    /**
+     * Compares two bool values. <code>false</code> is considered to be
+     * less than <code>true</code>.
+     *
+     * @param left
+     *            The left value to compare.
+     * @param right
+     *            The right value to compare.
+     * @return <code>-1</code> if <code>left</code> is <code>false</code>
+     *         and <code>right</code> is <code>true</code>;<code>0</code>
+     *         if they are equal; <code>1</code> if <code>left</code> is
+     *         <code>true</code> and <code>right</code> is
+     *         <code>false</code>
+     */
+    public static final int compare(bool left, bool right) {
+        return left is false ? (right is true ? -1 : 0) : (right is true ? 0
+                : 1);
+    }
+
+    /**
+     * Compares two comparable objects, but with protection against
+     * <code>null</code>.
+     *
+     * @param left
+     *            The left value to compare; may be <code>null</code>.
+     * @param right
+     *            The right value to compare; may be <code>null</code>.
+     * @return <code>-1</code> if <code>left</code> is <code>null</code>
+     *         and <code>right</code> is not <code>null</code>;
+     *         <code>0</code> if they are both <code>null</code>;
+     *         <code>1</code> if <code>left</code> is not <code>null</code>
+     *         and <code>right</code> is <code>null</code>. Otherwise, the
+     *         result of <code>left.compareTo(right)</code>.
+     */
+    public static final int compare(Comparable left,
+            Comparable right) {
+        if (left is null && right is null) {
+            return 0;
+        } else if (left is null) {
+            return -1;
+        } else if (right is null) {
+            return 1;
+        } else {
+            return left.compareTo( cast(Object)right);
+        }
+    }
+
+    /**
+     * Compares two integer values. This method fails if the distance between
+     * <code>left</code> and <code>right</code> is greater than
+     * <code>Integer.MAX_VALUE</code>.
+     *
+     * @param left
+     *            The left value to compare.
+     * @param right
+     *            The right value to compare.
+     * @return <code>left - right</code>
+     */
+    public static final int compare(int left, int right) {
+        return left - right;
+    }
+
+    /**
+     * Compares two objects that are not otherwise comparable. If neither object
+     * is <code>null</code>, then the string representation of each object is
+     * used.
+     *
+     * @param left
+     *            The left value to compare. The string representation of this
+     *            value must not be <code>null</code>.
+     * @param right
+     *            The right value to compare. The string representation of this
+     *            value must not be <code>null</code>.
+     * @return <code>-1</code> if <code>left</code> is <code>null</code>
+     *         and <code>right</code> is not <code>null</code>;
+     *         <code>0</code> if they are both <code>null</code>;
+     *         <code>1</code> if <code>left</code> is not <code>null</code>
+     *         and <code>right</code> is <code>null</code>. Otherwise, the
+     *         result of
+     *         <code>left.toString().compareTo(right.toString())</code>.
+     */
+    public static final int compare(Object left, Object right) {
+        if (left is null && right is null) {
+            return 0;
+        } else if (left is null) {
+            return -1;
+        } else if (right is null) {
+            return 1;
+        } else {
+            return left.toString() < (right.toString());
+        }
+    }
+    public static final int compare(Object[] left, Object[] right) {
+        if (left.length !is right.length ) {
+            return left.length < right.length;
+        }
+        for( int i = 0; i < left.length; i++ ){
+            int res = left[i].opCmp(right[i]);
+            if( res !is 0 ){
+                return res;
+            }
+        }
+        return 0;
+    }
+    public static final int compare(String left, String right) {
+        return left < right;
+    }
+
+    /**
+     * Decides whether two booleans are equal.
+     *
+     * @param left
+     *            The first bool to compare; may be <code>null</code>.
+     * @param right
+     *            The second bool to compare; may be <code>null</code>.
+     * @return <code>true</code> if the booleans are equal; <code>false</code>
+     *         otherwise.
+     */
+    public static bool equals(bool left, bool right) {
+        return left is right;
+    }
+
+    /**
+     * Decides whether two objects are equal -- defending against
+     * <code>null</code>.
+     *
+     * @param left
+     *            The first object to compare; may be <code>null</code>.
+     * @param right
+     *            The second object to compare; may be <code>null</code>.
+     * @return <code>true</code> if the objects are equals; <code>false</code>
+     *         otherwise.
+     */
+    public static bool equals(Object left, Object right) {
+        return left is null ? right is null : ((right !is null) && (left
+                .opEquals(right)) !is 0 );
+    }
+    public static bool equals(String left, String right) {
+        return left == right;
+    }
+    public static bool equals(String[] left, String[] right) {
+        if( left.length !is right.length ){
+            return false;
+        }
+        for( int i = 0; i < left.length; i++ ){
+            if( !equals( left[i], right[i] )){
+                return false;
+            }
+        }
+        return true;
+    }
+
+    /**
+     * Tests whether two arrays of objects are equal to each other. The arrays
+     * must not be <code>null</code>, but their elements may be
+     * <code>null</code>.
+     *
+     * @param leftArray
+     *            The left array to compare; may be <code>null</code>, and
+     *            may be empty and may contain <code>null</code> elements.
+     * @param rightArray
+     *            The right array to compare; may be <code>null</code>, and
+     *            may be empty and may contain <code>null</code> elements.
+     * @return <code>true</code> if the arrays are equal length and the
+     *         elements at the same position are equal; <code>false</code>
+     *         otherwise.
+     */
+    public static bool equals(Object[] leftArray,
+            Object[] rightArray) {
+        if (leftArray is null) {
+            return (rightArray is null);
+        } else if (rightArray is null) {
+            return false;
+        }
+
+        if (leftArray.length !is rightArray.length) {
+            return false;
+        }
+
+        for (int i = 0; i < leftArray.length; i++) {
+            Object left = leftArray[i];
+            Object right = rightArray[i];
+            bool equal = (left is null) ? (right is null) : (left
+                    .opEquals(right) !is 0);
+            if (!equal) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Computes the hash code for an integer.
+     *
+     * @param i
+     *            The integer for which a hash code should be computed.
+     * @return <code>i</code>.
+     */
+    public static final hash_t toHash(int i) {
+        return i;
+    }
+
+    /**
+     * Computes the hash code for an object, but with defense against
+     * <code>null</code>.
+     *
+     * @param object
+     *            The object for which a hash code is needed; may be
+     *            <code>null</code>.
+     * @return The hash code for <code>object</code>; or <code>0</code> if
+     *         <code>object</code> is <code>null</code>.
+     */
+    public static final hash_t toHash( Object object) {
+        return object !is null ? object.toHash() : 0;
+    }
+    public static final hash_t toHash( char[] str) {
+        return str !is null ? java.lang.all.toHash( str ) : 0;
+    }
+/++
+
+    /**
+     * Makes a type-safe copy of the given map. This method should be used when
+     * a map is crossing an API boundary (i.e., from a hostile plug-in into
+     * internal code, or vice versa).
+     *
+     * @param map
+     *            The map which should be copied; must not be <code>null</code>.
+     * @param keyClass
+     *            The class that all the keys must be; must not be
+     *            <code>null</code>.
+     * @param valueClass
+     *            The class that all the values must be; must not be
+     *            <code>null</code>.
+     * @param allowNullKeys
+     *            Whether <code>null</code> keys should be allowed.
+     * @param allowNullValues
+     *            Whether <code>null</code> values should be allowed.
+     * @return A copy of the map; may be empty, but never <code>null</code>.
+     */
+    public static final Map safeCopy(final Map map, final Class keyClass,
+            final Class valueClass, final bool allowNullKeys,
+            final bool allowNullValues) {
+        if (map is null || keyClass is null || valueClass is null) {
+            throw new NullPointerException();
+        }
+
+        final Map copy = Collections.unmodifiableMap(new HashMap(map));
+        final Iterator iterator = copy.entrySet().iterator();
+
+        while (iterator.hasNext()) {
+            final Map.Entry entry = (Map.Entry) iterator.next();
+            assertInstance(entry.getKey(), keyClass, allowNullKeys);
+            assertInstance(entry.getValue(), valueClass, allowNullValues);
+        }
+
+        return map;
+    }
+
+    /**
+     * Makes a type-safe copy of the given set. This method should be used when
+     * a set is crossing an API boundary (i.e., from a hostile plug-in into
+     * internal code, or vice versa).
+     *
+     * @param set
+     *            The set which should be copied; must not be <code>null</code>.
+     * @param c
+     *            The class that all the values must be; must not be
+     *            <code>null</code>.
+     * @return A copy of the set; may be empty, but never <code>null</code>.
+     *         None of its element will be <code>null</code>.
+     */
+    public static final Set safeCopy(final Set set, final Class c) {
+        return safeCopy(set, c, false);
+    }
+
+    /**
+     * Makes a type-safe copy of the given set. This method should be used when
+     * a set is crossing an API boundary (i.e., from a hostile plug-in into
+     * internal code, or vice versa).
+     *
+     * @param set
+     *            The set which should be copied; must not be <code>null</code>.
+     * @param c
+     *            The class that all the values must be; must not be
+     *            <code>null</code>.
+     * @param allowNullElements
+     *            Whether null values should be allowed.
+     * @return A copy of the set; may be empty, but never <code>null</code>.
+     */
+    public static final Set safeCopy(final Set set, final Class c,
+            final bool allowNullElements) {
+        if (set is null || c is null) {
+            throw new NullPointerException();
+        }
+
+        final Set copy = Collections.unmodifiableSet(new HashSet(set));
+        final Iterator iterator = copy.iterator();
+
+        while (iterator.hasNext()) {
+            assertInstance(iterator.next(), c, allowNullElements);
+        }
+
+        return set;
+    }
+++/
+    /**
+     * The utility class is meant to just provide static members.
+     */
+    private this() {
+        // Should not be called.
+    }
+}