00001 /* 00002 * Copyright (c) 2000, 2020, Oracle and/or its affiliates. 00003 * 00004 * Licensed under the Universal Permissive License v 1.0 as shown at 00005 * http://oss.oracle.com/licenses/upl. 00006 */ 00007 #ifndef COH_SET_HPP 00008 #define COH_SET_HPP 00009 00010 #include "coherence/lang.ns" 00011 00012 #include "coherence/util/Collection.hpp" 00013 00014 COH_OPEN_NAMESPACE2(coherence,util) 00015 00016 00017 /** 00018 * A collection that contains no duplicate elements. As implied by 00019 * its name, this interface models the mathematical <i>set</i> abstraction. 00020 * 00021 * The <tt>Set</tt> interface places additional stipulations on the contracts 00022 * of all constructors of the <tt>Set</tt> implementations 00023 * and on the contracts of the <tt>add</tt> and <tt>equals</tt> methods. 00024 * 00025 * The additional stipulation on constructors is, not surprisingly, 00026 * that all constructors must create a set that contains no duplicate 00027 * elements. 00028 * 00029 * @see Collection 00030 */ 00031 class COH_EXPORT Set 00032 : public interface_spec<Set, 00033 implements<Collection> > 00034 { 00035 // ----- Collection interface ------------------------------------------- 00036 00037 public: 00038 /** 00039 * Add the specified element to this set if it is not already present. 00040 * If this set already contains the specified element, the call leaves 00041 * this set unchanged and returns <tt>false</tt>. 00042 * In combination with the restriction on constructors, this ensures 00043 * that sets never contain duplicate elements. 00044 * 00045 * @param v element to be added to this set. 00046 * 00047 * @return <tt>true</tt> iff this set did not already contain 00048 * the specified element. 00049 * 00050 * @throws coherence::lang::UnsupportedOperationException 00051 * if the #add() operation is not supported by this 00052 * collection. 00053 */ 00054 using Collection::add; 00055 00056 00057 // ----- Object interface ----------------------------------------------- 00058 00059 public: 00060 /** 00061 * Compare the specified object with this set for equality. Return 00062 * <tt>true</tt> if the specified object is also a set, the two sets 00063 * have the same size, and every member of the specified set is 00064 * contained in this set (or equivalently, every member of this set is 00065 * contained in the specified set). This definition ensures that the 00066 * equals() method works properly across different implementations of 00067 * the Set interface. 00068 * 00069 * @param v {@link coherence::lang::Object Object} to be compared 00070 * for equality with this set. 00071 * 00072 * @return @c true iff the specified Object is equal to this set. 00073 */ 00074 using Object::equals; 00075 00076 /** 00077 * Return the hash code value for this set. The hash code of a set 00078 * is defined to be the sum of the hash codes of the elements in 00079 * the set, where the hashcode of a <tt>NULL</tt> element is defined 00080 * to be zero. This ensures that <code>s1->equals(s2)</code> implies 00081 * that <code>s1->hashCode() == s2->hashCode()</code> for any two sets 00082 * <tt>s1</tt> and <tt>s2</tt>, as required by the general 00083 * contract of {@link coherence::lang::Object::hashCode() 00084 * Object::hashCode()}. 00085 * 00086 * @return the hash code value for this set. 00087 */ 00088 using Object::hashCode; 00089 }; 00090 00091 COH_CLOSE_NAMESPACE2 00092 00093 #endif // COH_SET_HPP